Class SoundCloudClient

constructor

• new SoundCloudClient(config: SoundCloudClientConfig): SoundCloudClient

  Creates a new SoundCloudClient instance.

  Parameters

  • config: SoundCloudClientConfig

    Client configuration including OAuth credentials and optional settings

  Returns SoundCloudClient

auth

likes

me

playlists

reposts

resolve

search

tracks

users

accessToken

• get accessToken(): string | undefined

  Get the currently stored access token, or undefined if none is set.

  Returns string | undefined

refreshToken

• get refreshToken(): string | undefined

  Get the currently stored refresh token, or undefined if none is set.

  Returns string | undefined

clearToken

• clearToken(): void

  Clear all stored tokens from this client instance.

  Returns void

fetchAll

• fetchAll<T>(
      firstPage: () => Promise<SoundCloudPaginatedResponse<T>>,
      options?: { maxItems?: number },
  ): Promise<T[]>

  Collects all pages into a single flat array.

  Type Parameters

  • T

  Parameters

  • firstPage: () => Promise<SoundCloudPaginatedResponse<T>>

    Function that fetches the first page

  • Optionaloptions: { maxItems?: number }

    Optional configuration

    • OptionalmaxItems?: number

      Maximum number of items to collect

  Returns Promise<T[]>

  A promise resolving to a flat array of all items

  Example

  const allTracks = await sc.fetchAll(() => sc.search.tracks('lofi'), { maxItems: 100 });
  console.log(allTracks.length);
  Copy

paginate

• paginate<T>(
      firstPage: () => Promise<SoundCloudPaginatedResponse<T>>,
  ): AsyncGenerator<T[], void, undefined>

  Async generator that follows next_href automatically, yielding each page's collection.

  Type Parameters

  • T

  Parameters

  • firstPage: () => Promise<SoundCloudPaginatedResponse<T>>

    Function that fetches the first page

  Returns AsyncGenerator<T[], void, undefined>

  An async generator yielding arrays of items (one per page)

  Example

  for await (const page of sc.paginate(() => sc.search.tracks('lofi'))) {
    console.log(page); // SoundCloudTrack[]
  }
  Copy

paginateItems

• paginateItems<T>(
      firstPage: () => Promise<SoundCloudPaginatedResponse<T>>,
  ): AsyncGenerator<T, void, undefined>

  Async generator that yields individual items across all pages.

  Type Parameters

  • T

  Parameters

  • firstPage: () => Promise<SoundCloudPaginatedResponse<T>>

    Function that fetches the first page

  Returns AsyncGenerator<T, void, undefined>

  An async generator yielding individual items

  Example

  for await (const track of sc.paginateItems(() => sc.search.tracks('lofi'))) {
    console.log(track.title); // single SoundCloudTrack
  }
  Copy

setToken

• setToken(accessToken: string, refreshToken?: string): void

  Store an access token (and optionally refresh token) on this client instance.

  Parameters

  • accessToken: string

    The OAuth access token to store

  • OptionalrefreshToken: string

    Optional refresh token for automatic token renewal

  Returns void