clippium - API documentation

Classes

Clippium<C>

Type Parameters

Type Parameter
C extends ClippiumData

Constructors

new Clippium()

new Clippium<C>(data: C, config: ClippiumConfig): Clippium<C>

Parameters

Parameter	Type
data	C
config	ClippiumConfig

Returns

Clippium<C>

Methods

help()

help(argv: Argv): string

Parameters

Parameter	Type
argv	Argv

Returns

string

run()

run(argv: Argv): Promise<void>

Parameters

Parameter	Type
argv	Argv

Returns

Promise<void>

version()

version(): undefined | string

Returns

undefined | string

Properties

Property	Type
config	ClippiumConfig
data	C
fn	(data: FnData<C>) => void | Promise<void>
parser	ParserData<C>

Functions

defineData()

function defineData<C>(data: C): C

Type Parameters

Type Parameter
C extends ClippiumData

Parameters

Parameter	Type
data	C

Returns

C

---

hiddenBin()

function hiddenBin(args: Argv): string[]

Parameters

Parameter	Type
args	Argv

Returns

string[]

Type Aliases

ClippiumConfig

type ClippiumConfig: {
  help: PartialDeep<HelpConfig>;
};

Type declaration

Name	Type
help?	PartialDeep<HelpConfig>

---

ClippiumData

type ClippiumData: {
  name: string;
  version: string;
 } & CommandOptions;

Type declaration

Name	Type
name?	string
version?	string

---

InferFlag<T>

type InferFlag<T>: InferOption<T>;

Type Parameters

Type Parameter
T extends Option

---

InferPosicional<T>

type InferPosicional<T>: InferOption<T>;

Type Parameters

Type Parameter
T extends Posicional