Variable SourceRegistryConst

Type Declaration

• createIdentifier: function

  • createIdentifier(source: RegistrySearchSource, query: string): string

    Build a lavalink identifier from a source and query.

    Parameters

    • source: RegistrySearchSource

      The source to use.

    • query: string

      The query to format.

    Returns string

    The formatted lavalink identifier.

• getRegistered: function

  • getRegistered(): string[]

    Returns all canonical registered sources.

    Returns string[]

    All canonical source identifiers.

• isRegistered: function

  • isRegistered(value: RegistrySearchSource): boolean

    Checks whether a source is registered.

    Parameters

    • value: RegistrySearchSource

      The value to check.

    Returns boolean

    Whether the source is registered.

• parseQuery: function

  • parseQuery(query: string): ParsedQuery | null

    Tries to parse an explicit source prefix from a query.

    Parameters

    • query: string

      The query to inspect.

    Returns ParsedQuery | null

    The parsed source information.

• register: function

  • register(...registrations: RestOrArray<SourceRegistration>): string[]

    Register one or multiple source definitions.

    Parameters

    • ...registrations: RestOrArray<SourceRegistration>

      The source registration payloads.

    Returns string[]

    The canonical source identifiers.

    Example

    SourceRegistry.register({
      source: "mysearch",
      name: "my-provider",
    });
    
    SourceRegistry.register(
      { source: "mysearch" },
      { source: "mytts", protocol: "double-slash" },
    );
    Copy

• resolve: function

  • resolve(value: RegistrySearchSource): string | undefined

    Get the canonical source from an alias or source name.

    Parameters

    • value: RegistrySearchSource

      The value to resolve.

    Returns string | undefined

    The canonical source identifier.