Skip to content

Commit 6a29356

Browse files
domain: add soft deprecation notice
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 <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]>
1 parent 870af9e commit 6a29356

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

doc/api/domain.markdown

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Stability: 2 - Unstable
44

5+
**This module is pending deprecation**. Once a replacement API has been
6+
finalized, this module will be fully deprecated. Most end users should
7+
**not** have cause to use this module. Users who absolutely must have
8+
the functionality that domains provide may rely on it for the time being
9+
but should expect to have to migrate to a different solution
10+
in the future.
11+
512
Domains provide a way to handle multiple different IO operations as a
613
single group. If any of the event emitters or callbacks registered to a
714
domain emit an `error` event, or throw an error, then the domain object

lib/domain.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@
2121

2222
'use strict';
2323

24+
// WARNING: THIS MODULE IS PENDING DEPRECATION.
25+
//
26+
// No new pull requests targeting this module will be accepted
27+
// unless they address existing, critical bugs.
28+
2429
var util = require('util');
2530
var EventEmitter = require('events');
2631
var inherits = util.inherits;

0 commit comments

Comments
 (0)