PHP 8.2.30
Preview: usage.d.ts Size: 2.05 KB
//proc/thread-self/root/home/byroehnu/.trash/node_modules11/yargs/build/lib/usage.d.ts

import { Dictionary } from './common-types';
import { YargsInstance } from './yargs';
import { YError } from './yerror';
import { Y18N } from 'y18n';
export declare function usage(yargs: YargsInstance, y18n: Y18N): UsageInstance;
/** Instance of the usage module. */
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>;
}

Directory Contents

Dirs: 0 × Files: 32

Name Size Perms Modified Actions
152 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
2.43 KB lrw-r--r-- 2026-02-27 09:44:56
Edit Download
178 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
2.69 KB lrw-r--r-- 2026-02-27 09:44:56
Edit Download
3.07 KB lrw-r--r-- 2026-02-27 09:45:04
Edit Download
17.61 KB lrw-r--r-- 2026-02-27 09:44:58
Edit Download
1.18 KB lrw-r--r-- 2026-02-27 09:45:04
Edit Download
774 B lrw-r--r-- 2026-02-27 09:44:58
Edit Download
1.43 KB lrw-r--r-- 2026-02-27 09:45:04
Edit Download
1.49 KB lrw-r--r-- 2026-02-27 09:44:58
Edit Download
994 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
6.04 KB lrw-r--r-- 2026-02-27 09:44:58
Edit Download
96 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
284 B lrw-r--r-- 2026-02-27 09:44:58
Edit Download
67 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
2.30 KB lrw-r--r-- 2026-02-27 09:44:58
Edit Download
764 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
2.46 KB lrw-r--r-- 2026-02-27 09:44:58
Edit Download
119 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
438 B lrw-r--r-- 2026-02-27 09:45:00
Edit Download
309 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
1.17 KB lrw-r--r-- 2026-02-27 09:45:00
Edit Download
115 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
1.35 KB lrw-r--r-- 2026-02-27 09:45:00
Edit Download
2.05 KB lrw-r--r-- 2026-02-27 09:45:04
Edit Download
19.94 KB lrw-r--r-- 2026-02-27 09:45:00
Edit Download
1.71 KB lrw-r--r-- 2026-02-27 09:45:04
Edit Download
13.13 KB lrw-r--r-- 2026-02-27 09:45:00
Edit Download
12.14 KB lrw-r--r-- 2026-02-27 09:45:04
Edit Download
47.52 KB lrw-r--r-- 2026-02-27 09:45:00
Edit Download
102 B lrw-r--r-- 2026-02-27 09:45:04
Edit Download
301 B lrw-r--r-- 2026-02-27 09:45:00
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).