Module cli/api

initApi

• initApi(argv: any[]): { argv: any[]; config: { commands: ICommandOptions[]; options: ISpawnmonOptions }; firstArg: string; hasCommand: (...command: string[]) => boolean; hasCommands: () => boolean; hasFlag: (...flag: string[]) => boolean; hasFlags: () => boolean; hasHelp: () => boolean; hasHelpArg: (key?: string) => boolean; run: () => void; show: { examples: (color?: string) => void; groups: (color?: string) => void; header: (usage?: boolean, padding?: boolean) => void; help: (key?: string) => void; item: (key: "color" | "delay" | "mute" | "onTimeout" | "version" | "onConnect" | "onConnectAddress" | "group" | "raw" | "maxProcesses" | "prefixAlign" | "defaultColor" | "condensed" | "prefix" | "prefixFill" | "prefixMax" | "pipeInput" | "sendEnter", color?: string) => void; logo: (padding?: PaddingKey) => void; message: (msg: string, color?: string, padding?: PaddingKey) => void; pad: (count?: number) => void; section: (label: string, color?: string, padding?: PaddingKey, indent?: string) => void } }

• Parameters

  • argv: any[]

  Returns { argv: any[]; config: { commands: ICommandOptions[]; options: ISpawnmonOptions }; firstArg: string; hasCommand: (...command: string[]) => boolean; hasCommands: () => boolean; hasFlag: (...flag: string[]) => boolean; hasFlags: () => boolean; hasHelp: () => boolean; hasHelpArg: (key?: string) => boolean; run: () => void; show: { examples: (color?: string) => void; groups: (color?: string) => void; header: (usage?: boolean, padding?: boolean) => void; help: (key?: string) => void; item: (key: "color" | "delay" | "mute" | "onTimeout" | "version" | "onConnect" | "onConnectAddress" | "group" | "raw" | "maxProcesses" | "prefixAlign" | "defaultColor" | "condensed" | "prefix" | "prefixFill" | "prefixMax" | "pipeInput" | "sendEnter", color?: string) => void; logo: (padding?: PaddingKey) => void; message: (msg: string, color?: string, padding?: PaddingKey) => void; pad: (count?: number) => void; section: (label: string, color?: string, padding?: PaddingKey, indent?: string) => void } }

  • argv: any[]

  • config: { commands: ICommandOptions[]; options: ISpawnmonOptions }

    • commands: ICommandOptions[]

    • options: ISpawnmonOptions

  • firstArg: string

  • hasCommand: (...command: string[]) => boolean

    • • (...command: string[]): boolean

      • Parameters

        • Rest ...command: string[]

        Returns boolean

  • hasCommands: () => boolean

    • • (): boolean

      • Returns boolean

  • hasFlag: (...flag: string[]) => boolean

    • • (...flag: string[]): boolean

      • Parameters

        • Rest ...flag: string[]

        Returns boolean

  • hasFlags: () => boolean

    • • (): boolean

      • Returns boolean

  • hasHelp: () => boolean

    • • (): boolean

      • Returns boolean

  • hasHelpArg: (key?: string) => boolean

    • • (key?: string): boolean

      • Parameters

        • key: string = ...

        Returns boolean

  • run: () => void

    • • (): void

      • Returns void

  • show: { examples: (color?: string) => void; groups: (color?: string) => void; header: (usage?: boolean, padding?: boolean) => void; help: (key?: string) => void; item: (key: "color" | "delay" | "mute" | "onTimeout" | "version" | "onConnect" | "onConnectAddress" | "group" | "raw" | "maxProcesses" | "prefixAlign" | "defaultColor" | "condensed" | "prefix" | "prefixFill" | "prefixMax" | "pipeInput" | "sendEnter", color?: string) => void; logo: (padding?: PaddingKey) => void; message: (msg: string, color?: string, padding?: PaddingKey) => void; pad: (count?: number) => void; section: (label: string, color?: string, padding?: PaddingKey, indent?: string) => void }

    • examples: (color?: string) => void

      • • (color?: string): void

        • Parameters

          • Optional color: string

          Returns void

    • groups: (color?: string) => void

      • • (color?: string): void

        • Parameters

          • Optional color: string

          Returns void

    • header: (usage?: boolean, padding?: boolean) => void

      • • (usage?: boolean, padding?: boolean): void

        • Parameters

          • usage: boolean = true

          • Optional padding: boolean

          Returns void

    • help: (key?: string) => void

      • • (key?: string): void

        • Parameters

          • key: string = ...

          Returns void

    • item: (key: "color" | "delay" | "mute" | "onTimeout" | "version" | "onConnect" | "onConnectAddress" | "group" | "raw" | "maxProcesses" | "prefixAlign" | "defaultColor" | "condensed" | "prefix" | "prefixFill" | "prefixMax" | "pipeInput" | "sendEnter", color?: string) => void

      • • (key: "color" | "delay" | "mute" | "onTimeout" | "version" | "onConnect" | "onConnectAddress" | "group" | "raw" | "maxProcesses" | "prefixAlign" | "defaultColor" | "condensed" | "prefix" | "prefixFill" | "prefixMax" | "pipeInput" | "sendEnter", color?: string): void

        • Parameters

          • key: "color" | "delay" | "mute" | "onTimeout" | "version" | "onConnect" | "onConnectAddress" | "group" | "raw" | "maxProcesses" | "prefixAlign" | "defaultColor" | "condensed" | "prefix" | "prefixFill" | "prefixMax" | "pipeInput" | "sendEnter"

          • Optional color: string

          Returns void

    • logo: (padding?: PaddingKey) => void

      • • (padding?: PaddingKey): void

        • Parameters

          • padding: PaddingKey = 'none'

          Returns void

    • message: (msg: string, color?: string, padding?: PaddingKey) => void

      • • (msg: string, color?: string, padding?: PaddingKey): void

        • Parameters

          • msg: string

          • Optional color: string

          • padding: PaddingKey = 'both'

          Returns void

    • pad: (count?: number) => void

      • • (count?: number): void

        • Parameters

          • count: number = 1

          Returns void

    • section: (label: string, color?: string, padding?: PaddingKey, indent?: string) => void

      • • (label: string, color?: string, padding?: PaddingKey, indent?: string): void

        • Parameters

          • label: string

          • Optional color: string

          • padding: PaddingKey = 'bottom'

          • indent: string = ''

          Returns void