@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface CommandRegistry

    Interface used by a CLI to register Command instances.

    interface CommandRegistry {
        getGlobalCommandByName(name: string): GlobalCommand | undefined;
        getGlobalCommands(): readonly GlobalCommand[];
        getGlobalCommandsByShortAlias(): ReadonlyMap<string, GlobalCommand>;
        getGlobalModifierCommandByName(
            name: string,
        ): GlobalModifierCommand | undefined;
        getGlobalModifierCommands(): readonly GlobalModifierCommand[];
        getGlobalModifierCommandsByNameNotProvidedByService(): ReadonlyMap<
            string,
            GlobalModifierCommand,
        >;
        getGlobalModifierCommandsByNameProvidedByService(
            serviceId: string,
        ): ReadonlyMap<string, GlobalModifierCommand>;
        getGlobalModifierCommandsByShortAliasNotProvidedByService(): ReadonlyMap<
            string,
            GlobalModifierCommand,
        >;
        getGlobalModifierCommandsByShortAliasProvidedByService(
            serviceId: string,
        ): ReadonlyMap<string, GlobalModifierCommand>;
        getGroupAndMemberCommandsByJoinedName(): ReadonlyMap<
            string,
            { command: SubCommand; groupCommand: GroupCommand },
        >;
        getGroupCommandAndMemberSubCommandByJoinedName(
            getGroupCommandAndMemberSubCommandByName: string,
        ): { command: SubCommand; groupCommand: GroupCommand } | undefined;
        getGroupCommandByName(name: string): GroupCommand | undefined;
        getGroupCommands(): readonly GroupCommand[];
        getNonModifierCommandsByName(): ReadonlyMap<string, Command>;
        getSubCommandByName(name: string): SubCommand | undefined;
        getSubCommands(): readonly SubCommand[];
    }
    Index
    getGlobalCommandByName getGlobalCommands getGlobalCommandsByShortAlias getGlobalModifierCommandByName getGlobalModifierCommands getGlobalModifierCommandsByNameNotProvidedByService getGlobalModifierCommandsByNameProvidedByService getGlobalModifierCommandsByShortAliasNotProvidedByService getGlobalModifierCommandsByShortAliasProvidedByService getGroupAndMemberCommandsByJoinedName getGroupCommandAndMemberSubCommandByJoinedName getGroupCommandByName getGroupCommands getNonModifierCommandsByName getSubCommandByName getSubCommands

    • Get a registered GlobalCommand by name.

      Parameters

      • name: string

      Returns GlobalCommand | undefined

    • Get all registered GlobalCommand instances.

      Returns readonly GlobalCommand[]

    • Get a map of all registered GlobalCommand instances by short alias.

      Returns ReadonlyMap<string, GlobalCommand>

    • Get a map of all registered GlobalModifierCommand instances by name not provided by a service.

      Returns ReadonlyMap<string, GlobalModifierCommand>

    • Get a map of all registered GlobalModifierCommand instances by name provided by the specified service.

      Parameters

      • serviceId: string

      Returns ReadonlyMap<string, GlobalModifierCommand>

    • Get a map of all registered GlobalModifierCommand instances by short alias not provided by a service.

      Returns ReadonlyMap<string, GlobalModifierCommand>

    • Get a map of all registered GlobalModifierCommand instances by short alias provided by the specified service.

      Parameters

      • serviceId: string

      Returns ReadonlyMap<string, GlobalModifierCommand>

    • Get a map of all registered GroupCommand and member SubCommand instance combinations by combined name e.g. <group-command-name>:<member-sub-command-name>.

      Returns ReadonlyMap<string, { command: SubCommand; groupCommand: GroupCommand }>

    • Get a registered GroupCommand and member SubCommand by combined name e.g. <group-command-name>:<member-sub-command-name>.

      Parameters

      • getGroupCommandAndMemberSubCommandByName: string

      Returns { command: SubCommand; groupCommand: GroupCommand } | undefined

    • Get a registered GroupCommand by name.

      Parameters

      • name: string

      Returns GroupCommand | undefined

    • Get all registered GroupCommand instances.

      Returns readonly GroupCommand[]

    • Get a map of all registered non-modifier Command instances by name.

      Returns ReadonlyMap<string, Command>

    • Get a registered SubCommand by name.

      Parameters

      • name: string

      Returns SubCommand | undefined

    • Get all registered SubCommand instances.

      Returns readonly SubCommand[]

    Settings
    Member Visibility

    On This Page
    Methods