Spotify OAuth Refresher

Refresh your Spotify access tokens, simple and easy

• Getting Started
• Examples
• Documentation
• Notes
• Contributing
• License

First, install the package

npm install spotify-oauth-refresher

or

yarn add spotify-oauth-refresher

Then you are ready to go. Import the package into your project and start using it!

const Updater = require("spotify-oauth-refresher");
const api = new Updater({ clientId: "xxxxx", clientSecret: "xxxxx" });

api.setAccessToken("xxxxx");
api.setRefreshToken("xxxxx");

// You will never need to manually refresh your access token again!
const me = await api.request({
  url: "https://api.spotify.com/v1/me",
  method: "get",
  authType: "bearer",
});

console.log(me.id);

class Updater

Methods

• constructor

  • args
    • config <UpdaterConfig> Config for the updater class. See below for more details

• setAccessToken

  • args
    • token <string, required> The access token you want the client to use
  • returns
    • this The current class instance

• setRefreshToken

  • args
    • token <string, required> The refresh token you want the client to use
  • returns
    • this The current class instance

• removeAccessToken

  • args
    • none
  • returns
    • this The current class instance

• removeRefreshToken

  • args
    • none
  • returns
    • this The current class instance

• request

  • args
    • config <UpdaterRequestConfig, required> Config for making the request. Extends AxiosRequestConfig
  • returns
    • AxiosPromise<T = any> The return value of the axios request. Resolves to AxiosResponse<T = any>

• refresh

  • args
    • none
  • returns
    • Promise<void>

Properties

• get accessToken <string | undefined> The current access token in use

• get refreshToken <string | undefined> The current refresh token in use

• get base64Creds <string> Base64 encoded client credentials

• storage <Storage | Cookies> The storage class. In browser environments it is an instance of the universal-cookie class. Otherwise it is an instance of the Storage class

class Storage

Methods

• set

  • args
    • name <string, required> The name of the value
    • value <any, optional> The value that the name should represent
  • returns
    • this The current Storage instance

• get

  • args
    • name <string, required> The name of the value to fetch
  • returns
    • <T = any> Can be set using TypeScript type arguments. Defaults to any

interface UpdaterConfig

• clientId: <string, required> The id of your Spotify client
• clientSecret <string, required> The secret of your Spotify client

interface UpdaterRequestConfig extends AxiosRequestConfig

• authType <AuthType | undefined> The authorization type to use

type AuthType

• bearer|basic Either of these two strings

Requests are handled through the Updater.requests method so that it can automatically refresh the tokens when a request fails due to expired tokens

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.