args-tokens 0.2.4 → 0.2.5

package/lib/cjs/index.d.ts

@@ -1,10 +1,38 @@
-type ArgTokenKind = 'option' | 'option-terminator' | 'positional';
+/**
+ * Argument token Kind
+ * - `option`: option token, support short option (e.g. `-x`) and long option (e.g. `--foo`)
+ * - `option-terminator`: option terminator (`--`) token, see guideline 10 in https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html
+ * - `positional`: positional token
+ */
+export type ArgTokenKind = 'option' | 'option-terminator' | 'positional';
+/**
+ * Argument token
+ */
 export interface ArgToken {
+    /**
+     * Argument token kind
+     */
     kind: ArgTokenKind;
+    /**
+     * Argument token index, e.g `--foo bar` => `--foo` index is 0, `bar` index is 1
+     */
     index: number;
+    /**
+     * Option name, e.g. `--foo` => `foo`, `-x` => `x`
+     */
     name?: string;
+    /**
+     * Raw option name, e.g. `--foo` => `--foo`, `-x` => `-x`
+     */
     rawName?: string;
+    /**
+     * Option value, e.g. `--foo=bar` => `bar`, `-x=bar` => `bar`.
+     * If the `allowCompatible` option is `true`, short option value will be same as Node.js `parseArgs` behavior.
+     */
     value?: string;
+    /**
+     * Inline value, e.g. `--foo=bar` => `true`, `-x=bar` => `true`.
+     */
     inlineValue?: boolean;
 }
 /**
@@ -19,9 +47,18 @@ export interface ParseOptions {
 }
 /**
  * Parse command line arguments
+ * @example
+ * ```js
+ * import { parseArgs } from 'args-tokens' // for Node.js and Bun
+ * // import { parseArgs } from 'jsr:@kazupon/args-tokens' // for Deno
+ *
+ * const tokens = parseArgs(['--foo', 'bar', '-x', '--bar=baz'])
+ * // do something with using tokens
+ * // ...
+ * console.log('tokens:', tokens)
+ * ```
  * @param args command line arguments
  * @param options parse options
  * @returns argument tokens
  */
 export declare function parseArgs(args: string[], options?: ParseOptions): ArgToken[];
-export {};

package/lib/cjs/index.js

@@ -16,6 +16,16 @@ const SHORT_OPTION_PREFIX = HYPHEN_CHAR;
 const LONG_OPTION_PREFIX = '--';
 /**
  * Parse command line arguments
+ * @example
+ * ```js
+ * import { parseArgs } from 'args-tokens' // for Node.js and Bun
+ * // import { parseArgs } from 'jsr:@kazupon/args-tokens' // for Deno
+ *
+ * const tokens = parseArgs(['--foo', 'bar', '-x', '--bar=baz'])
+ * // do something with using tokens
+ * // ...
+ * console.log('tokens:', tokens)
+ * ```
  * @param args command line arguments
  * @param options parse options
  * @returns argument tokens

package/lib/esm/index.d.ts

@@ -1,10 +1,38 @@
-type ArgTokenKind = 'option' | 'option-terminator' | 'positional';
+/**
+ * Argument token Kind
+ * - `option`: option token, support short option (e.g. `-x`) and long option (e.g. `--foo`)
+ * - `option-terminator`: option terminator (`--`) token, see guideline 10 in https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html
+ * - `positional`: positional token
+ */
+export type ArgTokenKind = 'option' | 'option-terminator' | 'positional';
+/**
+ * Argument token
+ */
 export interface ArgToken {
+    /**
+     * Argument token kind
+     */
     kind: ArgTokenKind;
+    /**
+     * Argument token index, e.g `--foo bar` => `--foo` index is 0, `bar` index is 1
+     */
     index: number;
+    /**
+     * Option name, e.g. `--foo` => `foo`, `-x` => `x`
+     */
     name?: string;
+    /**
+     * Raw option name, e.g. `--foo` => `--foo`, `-x` => `-x`
+     */
     rawName?: string;
+    /**
+     * Option value, e.g. `--foo=bar` => `bar`, `-x=bar` => `bar`.
+     * If the `allowCompatible` option is `true`, short option value will be same as Node.js `parseArgs` behavior.
+     */
     value?: string;
+    /**
+     * Inline value, e.g. `--foo=bar` => `true`, `-x=bar` => `true`.
+     */
     inlineValue?: boolean;
 }
 /**
@@ -19,9 +47,18 @@ export interface ParseOptions {
 }
 /**
  * Parse command line arguments
+ * @example
+ * ```js
+ * import { parseArgs } from 'args-tokens' // for Node.js and Bun
+ * // import { parseArgs } from 'jsr:@kazupon/args-tokens' // for Deno
+ *
+ * const tokens = parseArgs(['--foo', 'bar', '-x', '--bar=baz'])
+ * // do something with using tokens
+ * // ...
+ * console.log('tokens:', tokens)
+ * ```
  * @param args command line arguments
  * @param options parse options
  * @returns argument tokens
  */
 export declare function parseArgs(args: string[], options?: ParseOptions): ArgToken[];
-export {};

package/lib/esm/index.js

@@ -13,6 +13,16 @@ const SHORT_OPTION_PREFIX = HYPHEN_CHAR;
 const LONG_OPTION_PREFIX = '--';
 /**
  * Parse command line arguments
+ * @example
+ * ```js
+ * import { parseArgs } from 'args-tokens' // for Node.js and Bun
+ * // import { parseArgs } from 'jsr:@kazupon/args-tokens' // for Deno
+ *
+ * const tokens = parseArgs(['--foo', 'bar', '-x', '--bar=baz'])
+ * // do something with using tokens
+ * // ...
+ * console.log('tokens:', tokens)
+ * ```
  * @param args command line arguments
  * @param options parse options
  * @returns argument tokens

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "args-tokens",
   "description": "parseArgs tokens compatibility and more high-performance parser",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"