Type Alias RelevantArgsInput

Input for extractRelevantArgs.

type RelevantArgsInput = {
    binName: string | ReadonlyArray<string> | undefined;
    fileName: string;
    rawArgs: ReadonlyArray<string>;
}

Index

Properties

binName fileName rawArgs

Properties

binName

binName: string | ReadonlyArray<string> | undefined

Executable bin name for your script. This should be the "bin" name in your package.json, or simply your package name if you have no custom bin name defined.

See https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin for details on the bin field of package.json

fileName

fileName: string

The name or path of your script file that will be executed via the CLI. This should almost always simply be __filename in CJS or import.meta.filename in ESM.

rawArgs

rawArgs: ReadonlyArray<string>

Raw arguments passed to the CLI. Typically this will simply be process.argv.

Type Alias RelevantArgsInput

Index

Properties

Properties

binName

fileName

rawArgs

Settings

On This Page