From 7c76fddf2501bdd686c24f193a63c642a5a1c6a0 Mon Sep 17 00:00:00 2001 From: Colin Ihrig Date: Tue, 21 Feb 2023 10:48:00 -0500 Subject: [PATCH] util,doc: mark parseArgs() as stable Fixes: https://github.com/nodejs/node/issues/46640 PR-URL: https://github.com/nodejs/node/pull/46718 Reviewed-By: Yagiz Nizipli Reviewed-By: Moshe Atlow Reviewed-By: Luigi Pinca Reviewed-By: Antoine du Hamel Reviewed-By: James M Snell --- doc/api/util.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/api/util.md b/doc/api/util.md index bddfae17cbeca0..fa54f726f681b3 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1384,6 +1384,10 @@ added: - v18.3.0 - v16.17.0 changes: + - version: + - REPLACEME + pr-url: https://github.com/nodejs/node/pull/46718 + description: The API is no longer experimental. - version: - v18.11.0 - v16.19.0 @@ -1397,8 +1401,6 @@ changes: using `tokens` in input `config` and returned properties. --> -> Stability: 1 - Experimental - * `config` {Object} Used to provide arguments for parsing and to configure the parser. `config` supports the following properties: * `args` {string\[]} array of argument strings. **Default:** `process.argv` @@ -1477,9 +1479,6 @@ console.log(values, positionals); // Prints: [Object: null prototype] { foo: true, bar: 'b' } [] ``` -`util.parseArgs` is experimental and behavior may change. Join the -conversation in [pkgjs/parseargs][] to contribute to the design. - ### `parseArgs` `tokens` Detailed parse information is available for adding custom behaviours by @@ -3341,6 +3340,5 @@ util.log('Timestamped message.'); [default sort]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort [global symbol registry]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for [list of deprecated APIS]: deprecations.md#list-of-deprecated-apis -[pkgjs/parseargs]: https://github.com/pkgjs/parseargs [semantically incompatible]: https://github.com/nodejs/node/issues/4179 [util.inspect.custom]: #utilinspectcustom