Variable registerCommandConst

Type declaration

• • <CommandName extends CommandNames>(
        commandName: CommandName,
        handler: CommandHandlers[CommandName],
        commandDocs?: SingleMethodDocumentation,
        commandOptions?: NetworkMethodHandlerOptions,
    ): Promise<UnsubscriberAsync>

  • Type Parameters

    • CommandName extends CommandNames

    Parameters

    • commandName: CommandName

      Command name to register for handling here

      • Note: Command names must consist of two strings separated by at least one period. We recommend one period and lower camel case in case we expand the API in the future to allow dot notation.
    • handler: CommandHandlers[CommandName]

      Function to run when the command is invoked
    • OptionalcommandDocs: SingleMethodDocumentation

      Documentation for the command
    • OptionalcommandOptions: NetworkMethodHandlerOptions

      Options for the command

    Returns Promise<UnsubscriberAsync>

    Promise that resolves if the command successfully registered and unsubscriber function to run to stop the passed-in function from handling commands