spotify-oauth-simple
v1.1.8
Published
Refresh your Spotify access tokens, simple and easy
Downloads
14
Readme
Spotify OAuth Simple
Refresh your Spotify access tokens, simple and easy
- Getting Started
- Examples
- Documentation
- Notes
- Contributing
- License
First, install the package
npm install spotify-oauth-simple
or
yarn add spotify-oauth-simple
Then you are ready to go. Import the package into your project and start using it!
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
- args
setAccessToken
- args
token
<string, required> The access token you want the client to use
- returns
this
The current class instance
- args
removeAccessToken
- args
none
- returns
this
The current class instance
- args
request
- args
config
<UpdaterRequestConfig, required> Config for making the request. Extends AxiosRequestConfig
- returns
AxiosPromise<T = any>
The return value of the axios request. Resolves toAxiosResponse<T = any>
- args
refresh
- args
none
- returns
Promise<void>
- args
Properties
get
accessToken
<string | undefined> The existing access token in useget
base64Creds
<string> Base64 encoded client credentialsstorage
<Storage | Cookies> The storage class. In browser environments it is an instance of theuniversal-cookie
class. Otherwise it is an instance of the Storage class
class
Storage
Methods
set
- args
name
<string, required> The name of the valuevalue
<any, optional> The value that the name should represent
- returns
this
The current Storage instance
- args
get
- args
name
<string, required> The name of the value to fetch
- returns
<T = any>
Can be set using TypeScript type arguments. Defaults toany
- args
interface
UpdaterConfig
clientId
: <string, required> The id of your Spotify clientclientSecret
<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.