diff --git a/doc/api/cli.md b/doc/api/cli.md index 8e5915d5f9aef7..e003d38fe2cfb4 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -137,6 +137,20 @@ added: v0.11.14 Throw errors for deprecations. +### `--pending-deprecation` + + +Emit pending deprecation warnings. + +*Note*: Pending deprecations are generally identical to a runtime deprecation +with the notable exception that they are turned *off* by default and will not +be emitted unless either the `--pending-deprecation` command line flag, or the +`NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations +are used to provide a kind of selective "early warning" mechanism that +developers may leverage to detect deprecated API usage. + ### `--no-warnings` + +When set to `1`, emit pending deprecation warnings. + +*Note*: Pending deprecations are generally identical to a runtime deprecation +with the notable exception that they are turned *off* by default and will not +be emitted unless either the `--pending-deprecation` command line flag, or the +`NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations +are used to provide a kind of selective "early warning" mechanism that +developers may leverage to detect deprecated API usage. + ### `NODE_PRESERVE_SYMLINKS=1`