From 6a29356451e4f2a204c6319aa85923176dee92c1 Mon Sep 17 00:00:00 2001 From: Chris Dickinson Date: Wed, 10 Dec 2014 14:03:27 -0800 Subject: [PATCH] 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: https://github.com/iojs/io.js/pull/141 Reviewed-By: Colin Ihrig Reviewed-By: Ben Noordhuis --- doc/api/domain.markdown | 7 +++++++ lib/domain.js | 5 +++++ 2 files changed, 12 insertions(+) diff --git a/doc/api/domain.markdown b/doc/api/domain.markdown index d3bf1c8506f..6f9a1a958e9 100644 --- a/doc/api/domain.markdown +++ b/doc/api/domain.markdown @@ -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 diff --git a/lib/domain.js b/lib/domain.js index f35bf838ca6..7d0e4f2cb7c 100644 --- a/lib/domain.js +++ b/lib/domain.js @@ -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;