1.8.0 • Published 2 months ago
@types/sade v1.8.0
Installation
npm install --save @types/sade
Summary
This package contains type definitions for sade (https://github.com/lukeed/sade#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sade.
index.d.ts
// Type definitions for sade 1.7
// Project: https://github.com/lukeed/sade#readme
// Definitions by: Epimodev <https://github.com/Epimodev>
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
import * as mri from 'mri';
/**
* Sade is a small but powerful tool for building command-line interface (CLI) applications for Node.js that are fast, responsive, and helpful!
* It enables default commands, git-like subcommands, option flags with aliases, default option values with type-casting,
* required-vs-optional argument handling, command validation, and automated help text generation!
*/
declare namespace sade {
type Handler = (...args: any[]) => any;
interface CommandOptions {
/**
* Optionally define one or more aliases for the current Command.
* When declared, the `opts.alias` value is passed directly to the [`prog.alias`](#progaliasnames) method.
*/
alias?: string | string[] | undefined;
default?: boolean | undefined;
}
interface ParseOptions extends mri.Options {
lazy?: boolean | undefined;
}
interface LazyOutput {
name: string;
handler: Handler;
args: string[];
}
interface Sade {
/**
* Define one or more aliases for the current Command.
*/
alias(...names: string[]): Sade;
command(str: string, desc?: string, opts?: Readonly<CommandOptions>): Sade;
describe(str: string | ReadonlyArray<string>): Sade;
option(str: string, desc?: string, val?: string | number | boolean): Sade;
action(handler: Handler): Sade;
example(str: string): Sade;
version(str: string): Sade;
help(str: string): void;
parse(arr: string[], opts: { lazy: true } & ParseOptions): LazyOutput;
parse(arr: string[], opts?: ParseOptions): void;
}
}
declare function sade(str: string, isOne?: boolean): sade.Sade;
export = sade;
Additional Details
- Last updated: Sun, 12 Dec 2021 10:31:08 GMT
- Dependencies: @types/mri
- Global values: none
Credits
These definitions were written by Epimodev, and Piotr Błażejewicz.