Type Parameters

  • T extends string

Hierarchy

  • Error
    • DisTubeError

Constructors

  • Type Parameters

    • T extends string

    Parameters

    • code: StaticErrorCode

    Returns DisTubeError<T>

  • Type Parameters

    • T extends string

    Parameters

    • code: T extends TemplateErrorCode
          ? T<T>
          : never
    • Rest ...args: Parameters<{
          CANNOT_PLAY_RELATED: string;
          CANNOT_RESOLVE_SONG: ((t) => string);
          DISABLED_OPTION: ((o) => string);
          EMPTY_ARRAY: ((name) => string);
          EMPTY_FILTERED_ARRAY: ((name, type) => string);
          EMPTY_FILTERED_PLAYLIST: string;
          EMPTY_PLAYLIST: string;
          EMPTY_STRING: ((name) => string);
          ENABLED_OPTION: ((o) => string);
          FFMPEG_EXITED: ((code) => string);
          FFMPEG_NOT_INSTALLED: ((path) => string);
          INVALID_KEY: ((obj, key) => string);
          INVALID_TYPE: ((expected, got, name?) => string);
          MISSING_INTENTS: ((i) => string);
          MISSING_KEY: ((obj, key) => string);
          MISSING_KEYS: ((obj, key, all) => string);
          NON_NSFW: string;
          NOT_IN_VOICE: string;
          NOT_SUPPORTED_URL: string;
          NO_PLAYING: string;
          NO_PREVIOUS: string;
          NO_QUEUE: string;
          NO_RELATED: string;
          NO_RESULT: string;
          NO_SONG_POSITION: string;
          NO_UP_NEXT: string;
          NO_VALID_SONG: string;
          NUMBER_COMPARE: ((name, expected, value) => string);
          PAUSED: string;
          QUEUE_EXIST: string;
          RESUMED: string;
          UNAVAILABLE_VIDEO: string;
          UNPLAYABLE_FORMATS: string;
          VOICE_CONNECT_FAILED: ((s) => 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>

  • Type Parameters

    • T extends string

    Parameters

    • code: TemplateErrorCode
    • _: never

    Returns DisTubeError<T>

  • Type Parameters

    • T extends string

    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_CONNECT_FAILED" | "VOICE_MISSING_PERMS" | "VOICE_RECONNECT_FAILED" | "VOICE_DIFFERENT_GUILD" | "VOICE_DIFFERENT_CLIENT" | "FFMPEG_EXITED" | "FFMPEG_NOT_INSTALLED" | "NO_QUEUE" | "QUEUE_EXIST" | "PAUSED" | "RESUMED" | "NO_PREVIOUS" | "NO_UP_NEXT" | "NO_SONG_POSITION" | "NO_PLAYING" | "NO_RESULT" | "NO_RELATED" | "CANNOT_PLAY_RELATED" | "UNAVAILABLE_VIDEO" | "UNPLAYABLE_FORMATS" | "NON_NSFW" | "NOT_SUPPORTED_URL" | "CANNOT_RESOLVE_SONG" | "NO_VALID_SONG" | "EMPTY_FILTERED_PLAYLIST" | "EMPTY_PLAYLIST"
          ? "This is built-in error code"
          : T
    • message: string

    Returns DisTubeError<T>

Properties

cause?: unknown
errorCode: string
message: string
stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Accessors

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void