Skip to content

InspectedCommand ​

Resolved inputs for a single invocation. Later execution stages run on demand.

Signatures ​

ts
interface InspectedCommand extends ResolveResult {}

Members ​

Properties ​

kind ​

ts
kind: "match";

path ​

Canonical command names from the outermost group to the selected command.

ts
path: readonly string[];

meta ​

Program and leaf-command identity.

ts
meta: CommandMeta;

parse ​

Flag occurrences and metadata from argv transforms.

ts
parse: ParseContext;

execute ​

Resume this invocation once. Repeated calls share its promise and captured result.

ts
execute: { (): Promise<RunResult>; };

flags ​

Fully resolved flag values keyed by flag name.

ts
flags: Readonly<Record<string, unknown>>;

args ​

Fully resolved positional arg values keyed by arg name.

ts
args: Readonly<Record<string, unknown>>;

deprecations ​

Deprecation notices collected during resolution (may be empty).

ts
deprecations: readonly import("#internals/core/resolve/index.ts").DeprecationWarning[];

skippedPathChecks ​

Declared filesystem checks that did not run because no stat probe (or no mkdir for create) was supplied. Empty when every declared check ran, or when no resolved value had a check to run.

ts
skippedPathChecks: readonly import("#internals/core/resolve/index.ts").SkippedPathCheck[];

provenance ​

Which stage produced each value. Present only for inputs that resolved a value, so an unset optional input has no entry.

ts
provenance: import("#internals/core/resolve/index.ts").ResolutionProvenanceRecord;

See Also ​

Released under the MIT License.