nodejs
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <yagiz@nizipli.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Colin Ihrig 2023-02-21 10:48:00 -05:00 committed by GitHub
parent 629a8fa2df
commit 7c76fddf25
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/util.md
View File

@ -1384,6 +1384,10 @@ added:
- v18.3.0 - v18.3.0
- v16.17.0 - v16.17.0
changes: changes:
- version:
- REPLACEME
pr-url: https://github.com/nodejs/node/pull/46718
description: The API is no longer experimental.
- version: - version:
- v18.11.0 - v18.11.0
- v16.19.0 - v16.19.0
@ -1397,8 +1401,6 @@ changes:
using `tokens` in input `config` and returned properties. using `tokens` in input `config` and returned properties.
--> -->
> Stability: 1 - Experimental
* `config` {Object} Used to provide arguments for parsing and to configure * `config` {Object} Used to provide arguments for parsing and to configure
the parser. `config` supports the following properties: the parser. `config` supports the following properties:
* `args` {string\[]} array of argument strings. **Default:** `process.argv` * `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' } [] // 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` ### `parseArgs` `tokens`
Detailed parse information is available for adding custom behaviours by 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 [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 [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 [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 [semantically incompatible]: https://github.com/nodejs/node/issues/4179
[util.inspect.custom]: #utilinspectcustom [util.inspect.custom]: #utilinspectcustom