soundcloud-api-ts - v1.9.0
    Preparing search index...

    Class SoundCloudError

    Error class thrown when a SoundCloud API request fails.

    Provides structured access to HTTP status, error codes, and convenience getters for common error categories.

    import { SoundCloudError } from 'soundcloud-api-ts';

    try {
      await sc.tracks.getTrack(999999999);
    } catch (err) {
      if (err instanceof SoundCloudError) {
        if (err.isNotFound) console.log('Track not found');
        if (err.isRateLimited) console.log('Rate limited, retry later');
        console.log(err.status, err.message);
      }
    }

    Hierarchy

    • Error
      • SoundCloudError
    Index

    Constructors

    constructor

    Properties

    body? cause? docsLink? errorCode? errors message name stack? status statusText stackTraceLimit

    Accessors

    isForbidden isNotFound isRateLimited isServerError isUnauthorized

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Creates a new SoundCloudError.

      Parameters

      • status: number

        HTTP status code

      • statusText: string

        HTTP status text

      • Optionalbody: SoundCloudErrorBody

        Parsed JSON error response body from SoundCloud, if available

      Returns SoundCloudError

    Properties

    Optional Readonlybody

    body?: SoundCloudErrorBody

    The full parsed error response body, if available

    cause?: unknown
    docsLink?: string

    Link to SoundCloud API documentation, if included in the error response

    errorCode?: string

    Machine-readable error code from SoundCloud (e.g. "invalid_client"), if present

    errors: string[]

    Individual error messages extracted from the response body's errors array

    message: string
    name: string
    stack?: string
    status: number

    HTTP status code of the failed response (e.g. 401, 404, 429)

    statusText: string

    HTTP status text of the failed response (e.g. "Unauthorized", "Not Found")

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Accessors

    • get isForbidden(): boolean

      True if status is 403 Forbidden (insufficient permissions)

      Returns boolean

    • get isNotFound(): boolean

      True if status is 404 Not Found (resource does not exist)

      Returns boolean

    • get isRateLimited(): boolean

      True if status is 429 Too Many Requests (rate limit exceeded)

      Returns boolean

    • get isServerError(): boolean

      True if status is 5xx (SoundCloud server error)

      Returns boolean

    • get isUnauthorized(): boolean

      True if status is 401 Unauthorized (invalid or expired token)

      Returns boolean

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods