Skip to content

Commit

Permalink
util,doc: mark parseArgs() as stable
Browse files Browse the repository at this point in the history
Fixes: #46640
PR-URL: #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>
  • Loading branch information
cjihrig authored Feb 21, 2023
1 parent 629a8fa commit 7c76fdd
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit 7c76fdd

Please sign in to comment.