Skip to main content

Type Alias: FunctionWithArgOpts

FunctionWithArgOpts: object

Type declaration

defaultPath?

optional defaultPath: string

If the argument is a Directory or File type, default to load path from context directory, relative to root directory.

defaultValue?

optional defaultValue: JSON

A default value to use for this argument if not explicitly set by the caller, if any

description?

optional description: string

A doc string for the argument, if any

ignore?

optional ignore: string[]

Patterns to ignore when loading the contextual argument value.