Class KeysExportCommandAbstract

Hierarchy

Constructors

constructor

Properties

_client _dataPath _metadata _schema argv baseIPCClientFlags config debug id _base _enableJsonFlag _flags _globalFlags aliases args? deprecateAliases? deprecationOptions? description examples flags help hidden id parse parserOptions plugin run state? strict summary? usage

Accessors

ctor enableJsonFlag globalFlags

Methods

_run catch error exit finally init jsonEnabled log logToStderr parse printJSON run toErrorJson toSuccessJson warn warnIfCommandDeprecated warnIfFlagDeprecated

Constructors

constructor

Properties

Protected _client

_client: undefined | APIClient

Protected _dataPath

_dataPath: string

Protected _metadata

_metadata: ModuleMetadataJSON[]

Protected _schema

_schema: RegisteredSchema

argv

argv: string[]

Protected baseIPCClientFlags

baseIPCClientFlags: BaseIPCClientFlags

config

config: Config

Protected debug

debug: ((...args: any[]) => void)

Type declaration

    • (...args: any[]): void

    • Parameters

      • Rest ...args: any[]

      Returns void

id

id: undefined | string

Static _base

_base: string

Static _enableJsonFlag

_enableJsonFlag: boolean

Protected Static _flags

_flags: FlagInput<{
    [flag: string]: any;
}>

A hash of flags for the command

Protected Static _globalFlags

_globalFlags: FlagInput<{
    [flag: string]: any;
}>

Static aliases

aliases: string[]

An array of aliases for this command.

Static Optional args

args?: ArgInput

An order-dependent array of arguments for the command

Static Optional deprecateAliases

deprecateAliases?: boolean

Emit deprecation warning when a command alias is used

Static Optional deprecationOptions

deprecationOptions?: Deprecation

Static description

description: string = 'Export to <FILE>.'

A full description of how to use the command.

If no summary, the first line of the description will be used as the summary.

Static examples

examples: string[] = ...

An array of examples to show at the end of the command's help.

IF only a string is provided, it will try to look for a line that starts with the cmd.bin as the example command and the rest as the description. If found, the command will be formatted appropriately.

EXAMPLES:
  A description of a particular use case.

    $ <%= config.bin => command flags

Static flags

flags: {
    data-path: OptionFlag<undefined | string>;
    output: {
        aliases?: string[];
        char?: AlphabetLowercase | AlphabetUppercase;
        default?: Default<undefined | string, Record<string, unknown>>;
        defaultHelp?: DefaultHelp<undefined | string, Record<string, unknown>>;
        dependsOn?: string[];
        deprecateAliases?: boolean;
        deprecated?: true | Deprecation;
        description?: string;
        env?: string;
        exactlyOne?: string[];
        exclusive?: string[];
        helpGroup?: string;
        helpLabel?: string;
        helpValue?: string;
        hidden?: boolean;
        input: string[];
        multiple: false;
        name: string;
        options?: string[];
        parse: FlagParser<undefined | string, string, any>;
        relationships?: Relationship[];
        required: boolean;
        summary?: string;
        type: "option";
    } | {
        aliases?: string[];
        char?: AlphabetLowercase | AlphabetUppercase;
        default?: Default<undefined | (undefined | string)[], Record<string, unknown>>;
        defaultHelp?: DefaultHelp<undefined | string, Record<string, unknown>>;
        dependsOn?: string[];
        deprecateAliases?: boolean;
        deprecated?: true | Deprecation;
        description?: string;
        env?: string;
        exactlyOne?: string[];
        exclusive?: string[];
        helpGroup?: string;
        helpLabel?: string;
        helpValue?: string;
        hidden?: boolean;
        input: string[];
        multiple: true;
        name: string;
        options?: string[];
        parse: FlagParser<undefined | string, string, any>;
        relationships?: Relationship[];
        required: boolean;
        summary?: string;
        type: "option";
    };
    pretty: BooleanFlag<boolean>;
} = ...

Type declaration

  • data-path: OptionFlag<undefined | string>
  • output: {
        aliases?: string[];
        char?: AlphabetLowercase | AlphabetUppercase;
        default?: Default<undefined | string, Record<string, unknown>>;
        defaultHelp?: DefaultHelp<undefined | string, Record<string, unknown>>;
        dependsOn?: string[];
        deprecateAliases?: boolean;
        deprecated?: true | Deprecation;
        description?: string;
        env?: string;
        exactlyOne?: string[];
        exclusive?: string[];
        helpGroup?: string;
        helpLabel?: string;
        helpValue?: string;
        hidden?: boolean;
        input: string[];
        multiple: false;
        name: string;
        options?: string[];
        parse: FlagParser<undefined | string, string, any>;
        relationships?: Relationship[];
        required: boolean;
        summary?: string;
        type: "option";
    } | {
        aliases?: string[];
        char?: AlphabetLowercase | AlphabetUppercase;
        default?: Default<undefined | (undefined | string)[], Record<string, unknown>>;
        defaultHelp?: DefaultHelp<undefined | string, Record<string, unknown>>;
        dependsOn?: string[];
        deprecateAliases?: boolean;
        deprecated?: true | Deprecation;
        description?: string;
        env?: string;
        exactlyOne?: string[];
        exclusive?: string[];
        helpGroup?: string;
        helpLabel?: string;
        helpValue?: string;
        hidden?: boolean;
        input: string[];
        multiple: true;
        name: string;
        options?: string[];
        parse: FlagParser<undefined | string, string, any>;
        relationships?: Relationship[];
        required: boolean;
        summary?: string;
        type: "option";
    }
  • pretty: BooleanFlag<boolean>

Static help

help: undefined | string

Static hidden

hidden: boolean

Hide the command from help

Static id

id: string

A command ID, used mostly in error or verbose reporting.

Static parse

parse: boolean

Static parserOptions

parserOptions: {}

Type declaration

    Static plugin

    plugin: undefined | Plugin

    Static run

    run: ((argv?: string[], config?: LoadOptions) => PromiseLike<any>)

    Type declaration

      • (argv?: string[], config?: LoadOptions): PromiseLike<any>

      • instantiate and run the command

        Parameters

        • Optional argv: string[]

          argv

        • Optional config: LoadOptions

        Returns PromiseLike<any>

    Static Optional state

    state?: string

    Mark the command as a given state (e.g. beta or deprecated) in help

    Static strict

    strict: boolean

    When set to false, allows a variable amount of arguments

    Static Optional summary

    summary?: string

    The tweet-sized description for your class, used in a parent-commands sub-command listing and as the header for the command help.

    Static usage

    usage: undefined | string | string[]

    An override string (or strings) for the default usage documentation.

    Accessors

    ctor

    • get ctor(): typeof default

    • Returns typeof default

    Static enableJsonFlag

    • get enableJsonFlag(): boolean

    • Returns boolean

    • set enableJsonFlag(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    Static globalFlags

    • get globalFlags(): FlagInput<{
          [flag: string]: any;
      }>

    • Returns FlagInput<{
          [flag: string]: any;
      }>

    • set globalFlags(flags: FlagInput<{
          [flag: string]: any;
      }>): void

    • Parameters

      • flags: FlagInput<{
            [flag: string]: any;
        }>

      Returns void

    Methods

    _run

    • _run<T>(): Promise<undefined | T>

    • Type Parameters

      • T

      Returns Promise<undefined | T>

    Protected catch

    • Parameters

      • err: CommandError

      Returns Promise<any>

    error

    • Parameters

      • input: string | Error
      • options: {
            code?: string;
            exit: false;
        } & PrettyPrintableError

      Returns void

    • Parameters

      • input: string | Error
      • Optional options: {
            code?: string;
            exit?: number;
        } & PrettyPrintableError

      Returns never

    exit

    • Parameters

      • Optional code: number

      Returns void

    finally

    init

    jsonEnabled

    log

    • Parameters

      • Optional message: string
      • Rest ...args: any[]

      Returns void

    logToStderr

    • Parameters

      • Optional message: string
      • Rest ...args: any[]

      Returns void

    Protected parse

    • Type Parameters

      • F extends FlagOutput

      • G extends FlagOutput

      • A extends {
            [name: string]: any;
        }

      Parameters

      • Optional options: Input<F, G>
      • Optional argv: string[]

      Returns Promise<ParserOutput<F, G, A>>

    printJSON

    run

    Protected toErrorJson

    • Parameters

      • err: unknown

      Returns any

    Protected toSuccessJson

    • Parameters

      • result: unknown

      Returns any

    warn

    • Parameters

      • input: string | Error

      Returns string | Error

    Protected warnIfCommandDeprecated

    Protected warnIfFlagDeprecated

    • Parameters

      • flags: Record<string, unknown>

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc