Class DisTubeError<T>

constructor

• new DisTubeError<T extends string = any>(
      code: T extends StaticErrorCode ? T<T> : never,
  ): DisTubeError<T>

  Type Parameters

  • T extends string = any

  Parameters

  • code: T extends StaticErrorCode ? T<T> : never

  Returns DisTubeError<T>

• new DisTubeError<T extends string = any>(
      code: T extends TemplateErrorCode ? T<T> : never,
      ...args: Parameters<
          {
              CANNOT_GET_SEARCH_QUERY: (song: string) => string;
              CANNOT_GET_STREAM_URL: (song: string) => string;
              CANNOT_PLAY_RELATED: string;
              CANNOT_RESOLVE_SONG: (t: any) => string;
              DISABLED_OPTION: (o: string) => string;
              EMPTY_ARRAY: (name: string) => string;
              EMPTY_FILTERED_ARRAY: (name: string, type: string) => string;
              EMPTY_FILTERED_PLAYLIST: string;
              EMPTY_PLAYLIST: string;
              EMPTY_STRING: (name: string) => string;
              ENABLED_OPTION: (o: string) => string;
              ENCRYPTION_LIBRARIES_MISSING: string;
              FFMPEG_EXITED: (code: number) => string;
              FFMPEG_NOT_INSTALLED: (path: string) => string;
              INVALID_KEY: (obj: string, key: string) => string;
              INVALID_TYPE: (
                  expected: string | number | readonly (string | number)[],
                  got: any,
                  name?: string,
              ) => string;
              MISSING_INTENTS: (i: string) => string;
              MISSING_KEY: (obj: string, key: string) => string;
              MISSING_KEYS: (obj: string, key: string[], all: boolean) => string;
              NO_EXTRACTOR_PLUGIN: string;
              NO_PLAYING_SONG: string;
              NO_PREVIOUS: string;
              NO_QUEUE: string;
              NO_RELATED: string;
              NO_RESULT: (query: string) => string;
              NO_SONG_POSITION: string;
              NO_STREAM_URL: (song: string) => string;
              NO_UP_NEXT: string;
              NO_VALID_SONG: string;
              NON_NSFW: string;
              NOT_IN_VOICE: string;
              NOT_SUPPORTED_SONG: (song: string) => string;
              NOT_SUPPORTED_URL: string;
              NUMBER_COMPARE: (name: string, expected: string, value: number) => string;
              PAUSED: string;
              QUEUE_EXIST: string;
              QUEUE_STOPPED: string;
              RESUMED: string;
              UNAVAILABLE_VIDEO: string;
              UNPLAYABLE_FORMATS: string;
              VOICE_ALREADY_CREATED: string;
              VOICE_CONNECT_FAILED: (s: number) => string;
              VOICE_DIFFERENT_CLIENT: string;
              VOICE_DIFFERENT_GUILD: string;
              VOICE_FULL: string;
              VOICE_MISSING_PERMS: string;
              VOICE_RECONNECT_FAILED: string;
          }[T extends TemplateErrorCode ? T<T> : never],
      >,
  ): DisTubeError<T>

  Type Parameters

  • T extends string = any

  Parameters

  • code: T extends TemplateErrorCode ? T<T> : never
  • ...args: Parameters<
        {
            CANNOT_GET_SEARCH_QUERY: (song: string) => string;
            CANNOT_GET_STREAM_URL: (song: string) => string;
            CANNOT_PLAY_RELATED: string;
            CANNOT_RESOLVE_SONG: (t: any) => string;
            DISABLED_OPTION: (o: string) => string;
            EMPTY_ARRAY: (name: string) => string;
            EMPTY_FILTERED_ARRAY: (name: string, type: string) => string;
            EMPTY_FILTERED_PLAYLIST: string;
            EMPTY_PLAYLIST: string;
            EMPTY_STRING: (name: string) => string;
            ENABLED_OPTION: (o: string) => string;
            ENCRYPTION_LIBRARIES_MISSING: string;
            FFMPEG_EXITED: (code: number) => string;
            FFMPEG_NOT_INSTALLED: (path: string) => string;
            INVALID_KEY: (obj: string, key: string) => string;
            INVALID_TYPE: (
                expected: string | number | readonly (string | number)[],
                got: any,
                name?: string,
            ) => string;
            MISSING_INTENTS: (i: string) => string;
            MISSING_KEY: (obj: string, key: string) => string;
            MISSING_KEYS: (obj: string, key: string[], all: boolean) => string;
            NO_EXTRACTOR_PLUGIN: string;
            NO_PLAYING_SONG: string;
            NO_PREVIOUS: string;
            NO_QUEUE: string;
            NO_RELATED: string;
            NO_RESULT: (query: string) => string;
            NO_SONG_POSITION: string;
            NO_STREAM_URL: (song: string) => string;
            NO_UP_NEXT: string;
            NO_VALID_SONG: string;
            NON_NSFW: string;
            NOT_IN_VOICE: string;
            NOT_SUPPORTED_SONG: (song: string) => string;
            NOT_SUPPORTED_URL: string;
            NUMBER_COMPARE: (name: string, expected: string, value: number) => string;
            PAUSED: string;
            QUEUE_EXIST: string;
            QUEUE_STOPPED: string;
            RESUMED: string;
            UNAVAILABLE_VIDEO: string;
            UNPLAYABLE_FORMATS: string;
            VOICE_ALREADY_CREATED: string;
            VOICE_CONNECT_FAILED: (s: number) => string;
            VOICE_DIFFERENT_CLIENT: string;
            VOICE_DIFFERENT_GUILD: string;
            VOICE_FULL: string;
            VOICE_MISSING_PERMS: string;
            VOICE_RECONNECT_FAILED: string;
        }[T extends TemplateErrorCode ? T<T> : never],
    >

  Returns DisTubeError<T>

• new DisTubeError<T extends string = any>(
      code: TemplateErrorCode,
      _: never,
  ): DisTubeError<T>

  Type Parameters

  • T extends string = any

  Parameters

  • code: TemplateErrorCode
  • _: never

  Returns DisTubeError<T>

• new DisTubeError<T extends string = any>(
      code: T extends | "INVALID_TYPE"
      | "NUMBER_COMPARE"
      | "EMPTY_ARRAY"
      | "EMPTY_FILTERED_ARRAY"
      | "EMPTY_STRING"
      | "INVALID_KEY"
      | "MISSING_KEY"
      | "MISSING_KEYS"
      | "MISSING_INTENTS"
      | "DISABLED_OPTION"
      | "ENABLED_OPTION"
      | "NOT_IN_VOICE"
      | "VOICE_FULL"
      | "VOICE_ALREADY_CREATED"
      | "VOICE_CONNECT_FAILED"
      | "VOICE_MISSING_PERMS"
      | "VOICE_RECONNECT_FAILED"
      | "VOICE_DIFFERENT_GUILD"
      | "VOICE_DIFFERENT_CLIENT"
      | "FFMPEG_EXITED"
      | "FFMPEG_NOT_INSTALLED"
      | "ENCRYPTION_LIBRARIES_MISSING"
      | "NO_QUEUE"
      | "QUEUE_EXIST"
      | "QUEUE_STOPPED"
      | "PAUSED"
      | "RESUMED"
      | "NO_PREVIOUS"
      | "NO_UP_NEXT"
      | "NO_SONG_POSITION"
      | "NO_PLAYING_SONG"
      | "NO_EXTRACTOR_PLUGIN"
      | "NO_RELATED"
      | "CANNOT_PLAY_RELATED"
      | "UNAVAILABLE_VIDEO"
      | "UNPLAYABLE_FORMATS"
      | "NON_NSFW"
      | "NOT_SUPPORTED_URL"
      | "NOT_SUPPORTED_SONG"
      | "NO_VALID_SONG"
      | "CANNOT_RESOLVE_SONG"
      | "CANNOT_GET_STREAM_URL"
      | "CANNOT_GET_SEARCH_QUERY"
      | "NO_RESULT"
      | "NO_STREAM_URL"
      | "EMPTY_FILTERED_PLAYLIST"
      | "EMPTY_PLAYLIST"
          ? never
          : T,
      message: string,
  ): DisTubeError<T>

  Type Parameters

  • T extends string = any

  Parameters

  • code: T extends | "INVALID_TYPE"
    | "NUMBER_COMPARE"
    | "EMPTY_ARRAY"
    | "EMPTY_FILTERED_ARRAY"
    | "EMPTY_STRING"
    | "INVALID_KEY"
    | "MISSING_KEY"
    | "MISSING_KEYS"
    | "MISSING_INTENTS"
    | "DISABLED_OPTION"
    | "ENABLED_OPTION"
    | "NOT_IN_VOICE"
    | "VOICE_FULL"
    | "VOICE_ALREADY_CREATED"
    | "VOICE_CONNECT_FAILED"
    | "VOICE_MISSING_PERMS"
    | "VOICE_RECONNECT_FAILED"
    | "VOICE_DIFFERENT_GUILD"
    | "VOICE_DIFFERENT_CLIENT"
    | "FFMPEG_EXITED"
    | "FFMPEG_NOT_INSTALLED"
    | "ENCRYPTION_LIBRARIES_MISSING"
    | "NO_QUEUE"
    | "QUEUE_EXIST"
    | "QUEUE_STOPPED"
    | "PAUSED"
    | "RESUMED"
    | "NO_PREVIOUS"
    | "NO_UP_NEXT"
    | "NO_SONG_POSITION"
    | "NO_PLAYING_SONG"
    | "NO_EXTRACTOR_PLUGIN"
    | "NO_RELATED"
    | "CANNOT_PLAY_RELATED"
    | "UNAVAILABLE_VIDEO"
    | "UNPLAYABLE_FORMATS"
    | "NON_NSFW"
    | "NOT_SUPPORTED_URL"
    | "NOT_SUPPORTED_SONG"
    | "NO_VALID_SONG"
    | "CANNOT_RESOLVE_SONG"
    | "CANNOT_GET_STREAM_URL"
    | "CANNOT_GET_SEARCH_QUERY"
    | "NO_RESULT"
    | "NO_STREAM_URL"
    | "EMPTY_FILTERED_PLAYLIST"
    | "EMPTY_PLAYLIST"
        ? never
        : T
  • message: string

  Returns DisTubeError<T>

errorCode

code

• get code(): string

  Returns string

name

• get name(): string

  Returns string