Gecko [ c.stage.kornherr.net ]

Name	Size	Permission	Date
platform-shims	[ DIR ]	drwxr-xr-x	2023-12-23 20:12
typings	[ DIR ]	drwxr-xr-x	2023-12-23 20:12
utils	[ DIR ]	drwxr-xr-x	2023-12-23 20:12
argsert.d.ts	180 B	-rw-r--r--	2022-12-01 14:49
argsert.js	2.42 KB	-rw-r--r--	2022-12-01 14:49
cjs.d.ts	1.92 KB	-rw-r--r--	2022-12-01 14:49
command.d.ts	3.18 KB	-rw-r--r--	2022-12-01 14:49
command.js	15.07 KB	-rw-r--r--	2022-12-01 14:49
completion-templates.d.ts	1.43 KB	-rw-r--r--	2022-12-01 14:49
completion-templates.js	1.36 KB	-rw-r--r--	2022-12-01 14:49
completion.d.ts	1.06 KB	-rw-r--r--	2022-12-01 14:49
completion.js	5.4 KB	-rw-r--r--	2022-12-01 14:49
middleware.d.ts	785 B	-rw-r--r--	2022-12-01 14:49
middleware.js	2.14 KB	-rw-r--r--	2022-12-01 14:49
parse-command.d.ts	331 B	-rw-r--r--	2022-12-01 14:49
parse-command.js	1.04 KB	-rw-r--r--	2022-12-01 14:49
usage.d.ts	2.1 KB	-rw-r--r--	2022-12-01 14:49
usage.js	19.36 KB	-rw-r--r--	2022-12-01 14:49
validation.d.ts	1.78 KB	-rw-r--r--	2022-12-01 14:49
validation.js	11.92 KB	-rw-r--r--	2022-12-01 14:49
yargs-factory.d.ts	12.76 KB	-rw-r--r--	2022-12-01 14:49
yargs-factory.js	41.24 KB	-rw-r--r--	2022-12-01 14:49
yerror.d.ts	106 B	-rw-r--r--	2022-12-01 14:49
yerror.js	181 B	-rw-r--r--	2022-12-01 14:49

Rename

import { Dictionary, PlatformShim, Y18N } from './typings/common-types.js';
import { YargsInstance } from './yargs-factory.js';
import { YError } from './yerror.js';
export declare function usage(yargs: YargsInstance, y18n: Y18N, shim: PlatformShim): UsageInstance;
export interface UsageInstance {
    cacheHelpMessage(): void;
    clearCachedHelpMessage(): void;
    command(cmd: string, description: string | undefined, isDefault: boolean, aliases: string[], deprecated?: boolean): void;
    deferY18nLookup(str: string): string;
    describe(keys: string | string[] | Dictionary<string>, desc?: string): void;
    epilog(msg: string): void;
    example(cmd: string, description?: string): void;
    fail(msg?: string | null, err?: YError | string): void;
    failFn(f: FailureFunction): void;
    freeze(): void;
    functionDescription(fn: {
        name?: string;
    }): string;
    getCommands(): [string, string, boolean, string[], boolean][];
    getDescriptions(): Dictionary<string | undefined>;
    getPositionalGroupName(): string;
    getUsage(): [string, string][];
    getUsageDisabled(): boolean;
    help(): string;
    reset(localLookup: Dictionary<boolean>): UsageInstance;
    showHelp(level: 'error' | 'log' | ((message: string) => void)): void;
    showHelpOnFail(enabled?: boolean | string, message?: string): UsageInstance;
    showVersion(): void;
    stringifiedValues(values?: any[], separator?: string): string;
    unfreeze(): void;
    usage(msg: string | null, description?: string | false): UsageInstance;
    version(ver: any): void;
    wrap(cols: number | null | undefined): void;
}
export interface FailureFunction {
    (msg: string | undefined | null, err: YError | string | undefined, usage: UsageInstance): void;
}
export interface FrozenUsageInstance {
    failMessage: string | undefined | null;
    failureOutput: boolean;
    usages: [string, string][];
    usageDisabled: boolean;
    epilogs: string[];
    examples: [string, string][];
    commands: [string, string, boolean, string[], boolean][];
    descriptions: Dictionary<string | undefined>;
}