Refresh your Spotify access tokens, simple and easy
npm install spotify-oauth-simpleRefresh your Spotify access tokens, simple and easy
---
- Getting Started
- Examples
- Documentation
- Notes
- Contributing
- License
---
First, install the package
``sh`
npm install spotify-oauth-simple
or
`sh`
yarn add spotify-oauth-simple
Then you are ready to go. Import the package into your project and start using it!
---
`js
const Updater = require("spotify-oauth-simple");
const spotifyApi = new Updater({ clientId: "your-client-id", clientSecret: "your-client-secret" });
spotifyApi.setAccessToken("existing-token");
// You will never need to manually refresh your access token again!
const getTrack = await spotifyApi.request({
url: "https://api.spotify.com/v1/tracks/" + "track-id",
method: "GET",
authType: "bearer",
});
console.log(getTrack.data);
`
---
#### class Updater
##### Methods
- constructor
- args
- config _\<UpdaterConfig\>_ Config for the updater class. See below for more details
- setAccessToken
- args
- token _this
- returns
- The current class instance
- removeAccessTokennone
- args
- this
- returns
- The current class instance
- request
- args
- config _<UpdaterRequestConfig, required>_ Config for making the request. Extends AxiosRequestConfigAxiosPromise
- returns
- The return value of the axios request. Resolves to AxiosResponse
- refreshnone
- args
- Promise
- returns
-
##### Properties
- get accessToken _
- get base64Creds _\
- 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 _value
- _this
- returns
- The current Storage instance
- getname
- args
- _
- returns
- Can be set using TypeScript type arguments. Defaults to any
#### interface UpdaterConfig
- clientId: _clientSecret
- _
#### 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
---
---
Copyright 2021 Hammaam
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.