From ec9d529a3271592a0360d3b7796e72c71a600f8f Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 27 Jul 2018 08:54:53 -0700 Subject: [PATCH] doc: documentation deprecation of process.binding MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is the first step in a long process of deprecating `process.binding()` and replacing it with `internalBinding()`. Eventually, once we have replaced internal uses of `process.binding()` with `internalBinding()`, we can escalate to a runtime deprecation and eventual end-of-life. PR-URL: https://github.com/nodejs/node/pull/22004 Reviewed-By: Gireesh Punathil Reviewed-By: Matteo Collina Reviewed-By: Colin Ihrig Reviewed-By: Vladimir de Turckheim Reviewed-By: Anna Henningsen Reviewed-By: Bryan English Reviewed-By: Vse Mozhet Byt Reviewed-By: Gus Caplan Reviewed-By: Сковорода Никита Андреевич Reviewed-By: Ruben Bridgewater Reviewed-By: Tobias Nießen Reviewed-By: Michaël Zasso Reviewed-By: Michael Dawson --- doc/api/deprecations.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index d771a3e0e7a02d..322e73c4c9f11a 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -929,6 +929,9 @@ Type: Documentation-only (supports [`--pending-deprecation`][]) Using `process.binding()` in general should be avoided. The type checking methods in particular can be replaced by using [`util.types`][]. +This deprecation has been superseded by the deprecation of the +`process.binding()` API ([DEP00XX](#DEP00XX)). + ### DEP0104: process.env string coercion @@ -987,6 +990,14 @@ Type: Documentation-only The option `produceCachedData` has been deprecated. Use [`script.createCachedData()`][] instead. + +### DEP00XX: process.binding() + +Type: Documentation-only + +The `process.binding()` API is intended for use by Node.js internal code +only. Use of `process.binding()` by userland code is unsupported. + [`--pending-deprecation`]: cli.html#cli_pending_deprecation [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size [`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array