Skip to content

Commit

Permalink
domain: add soft deprecation notice
Browse files Browse the repository at this point in the history
Per the TC meeting on 2014-12-10, domains will be "soft deprecated"
until a suitable replacement API is available; at which time they
will be fully deprecated. Full deprecation will include references
to replacement API and the application of util.deprecate to the domain
api.

PR-URL: #141
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  • Loading branch information
chrisdickinson committed Dec 12, 2014
1 parent 870af9e commit 6a29356
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/api/domain.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

Stability: 2 - Unstable

**This module is pending deprecation**. Once a replacement API has been
finalized, this module will be fully deprecated. Most end users should
**not** have cause to use this module. Users who absolutely must have
the functionality that domains provide may rely on it for the time being
but should expect to have to migrate to a different solution
in the future.

Domains provide a way to handle multiple different IO operations as a
single group. If any of the event emitters or callbacks registered to a
domain emit an `error` event, or throw an error, then the domain object
Expand Down
5 changes: 5 additions & 0 deletions lib/domain.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@

'use strict';

// WARNING: THIS MODULE IS PENDING DEPRECATION.
//
// No new pull requests targeting this module will be accepted
// unless they address existing, critical bugs.

var util = require('util');
var EventEmitter = require('events');
var inherits = util.inherits;
Expand Down

3 comments on commit 6a29356

@19h
Copy link
Contributor

@19h 19h commented on 6a29356 Dec 21, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any further information on why domain is deprecated?

@algesten
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in a nutshell. to make domains work, the consequences throughout the code are too severe. it's a soft deprecation (only documentation for now) in anticipation of "coming up with something better".

#141
#66

@19h
Copy link
Contributor

@19h 19h commented on 6a29356 Dec 21, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that addresses it :-)

Please sign in to comment.