Skip to content

Function: parseArgs()

Parse command line arguments.

Signature

ts
declare function parseArgs(args: string[], options?: ParserOptions): ArgToken[]

Parameters

NameTypeDescription
argsstring[]command line arguments
optionsParserOptionsparse options, about details see ParserOptions (optional)

Returns

ArgToken[] — Argument tokens.

Examples

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)

Released under the MIT License.