summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/@pkgjs/parseargs/examples/is-default-value.js
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/@pkgjs/parseargs/examples/is-default-value.js')
-rw-r--r--deps/npm/node_modules/@pkgjs/parseargs/examples/is-default-value.js25
1 files changed, 25 insertions, 0 deletions
diff --git a/deps/npm/node_modules/@pkgjs/parseargs/examples/is-default-value.js b/deps/npm/node_modules/@pkgjs/parseargs/examples/is-default-value.js
new file mode 100644
index 0000000000..0a67972b71
--- /dev/null
+++ b/deps/npm/node_modules/@pkgjs/parseargs/examples/is-default-value.js
@@ -0,0 +1,25 @@
+'use strict';
+
+// This example shows how to understand if a default value is used or not.
+
+// 1. const { parseArgs } = require('node:util'); // from node
+// 2. const { parseArgs } = require('@pkgjs/parseargs'); // from package
+const { parseArgs } = require('..'); // in repo
+
+const options = {
+ file: { short: 'f', type: 'string', default: 'FOO' },
+};
+
+const { values, tokens } = parseArgs({ options, tokens: true });
+
+const isFileDefault = !tokens.some((token) => token.kind === 'option' &&
+ token.name === 'file'
+);
+
+console.log(values);
+console.log(`Is the file option [${values.file}] the default value? ${isFileDefault}`);
+
+// Try the following:
+// node is-default-value.js
+// node is-default-value.js -f FILE
+// node is-default-value.js --file FILE