Interface AuthOptions

Hierarchy

  • AuthOptions

Properties

accessToken? accessTokenExpiresAt? accessTokenExpiresIn? autoRefreshToken? clientID? clientSecret? fetch? refreshExpiredAccessToken? refreshToken? scopes?

Properties

Optional accessToken

accessToken?: string

AAn Access Token that can be provided in subsequent calls, for example to Spotify Web API services.

Optional accessTokenExpiresAt

accessTokenExpiresAt?: Date

A Date object representing when the the access token expires

Optional accessTokenExpiresIn

accessTokenExpiresIn?: number

A number of seconds until the access token expires

Optional autoRefreshToken

autoRefreshToken?: boolean

Set to "true" if you want to automatically refresh the token before expiring.

Optional clientID

clientID?: string

Client ID used for client credentials grant

Optional clientSecret

clientSecret?: string

Client Secret used for client credentials grant

Optional fetch

fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • A custom fetch implementation.

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

Optional refreshExpiredAccessToken

refreshExpiredAccessToken?: boolean

Set to "true" if you want the access token to be refreshed when it needs to be used but has expired

Optional refreshToken

refreshToken?: string

A token that can be sent to the Spotify Accounts service in place of an authorization code. (When the access code expires, send a POST request to the Accounts service /api/token endpoint, but use this code in place of an authorization code. A new Access Token will be returned. A new refresh token might be returned too.)

Optional scopes

scopes?: SpotifyScope[]

Spotify scopes to use for user auth

Settings

Member Visibility

Theme

Generated using TypeDoc