spotify-node-wrapper - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

package.json

 {
   "name": "spotify-node-wrapper",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A simplified interface to interact with the Spotify Web API.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -52,99 +52,203 @@ # Spotify Node Wrapper
 
-Yet to be completed. Refer to code for more information until this is complete.
+*Documentation in progress. Refer to the provided code examples for guidance until full documentation is available.*
 
 ### getSpotifyAccessToken
-Get a Spotify access token for the given client ID, client secret, and redirect URI.
+Obtain a Spotify access token using the client ID, client secret, and redirect URI.
+```javascript
+// Example usage
+getSpotifyAccessToken('your_client_id', 'your_client_secret', 'your_redirect_uri')
+  .then(token => console.log('Access Token:', token));
+```
 
 ### getAlbum
-Retrieves detailed information about a specific album.
+Fetch detailed information about a specific album on Spotify.
+```javascript
+// Example usage
+getAlbum('your_access_token', 'album_id')
+  .then(album => console.log(album));
+```
 
 ### getSeveralAlbums
-Retrieves detailed information about multiple albums in a single request.
+Retrieve details for multiple albums in a single request.
+```javascript
+// Example usage
+getSeveralAlbums('your_access_token', ['album_id1', 'album_id2'])
+  .then(albums => console.log(albums));
+```
 
 ### getAlbumTracks
-Retrieves the tracks of a specific album.
+Get the tracks from a specific album.
+```javascript
+// Example usage
+getAlbumTracks('your_access_token', 'album_id')
+  .then(tracks => console.log(tracks));
+```
 
 ### getUsersSavedAlbums
-Retrieves a list of albums saved in the user's library.
+List albums saved in the user's Spotify library.
+```javascript
+// Yet to provide example usage
+```
 
 ### saveAlbumsForCurrentUser
-Saves one or more albums to the user's library.
+Save one or more albums to the user's Spotify library.
+```javascript
+// Yet to provide example usage
+```
 
 ### removeUsersSavedAlbums
-Removes one or more albums from the user's library.
+Remove one or more albums from the user's Spotify library.
+```javascript
+// Yet to provide example usage
+```
 
 ### checkUsersSavedAlbums
-Checks if one or more albums are saved in the user's library.
+Check if specific albums are in the user's Spotify library.
+```javascript
+// Yet to provide example usage
+```
 
 ### getNewReleases
-Retrieves a list of new album releases.
+Retrieve a list of newly released albums on Spotify.
+```javascript
+// Yet to provide example usage
+```
 
 ### getArtist
-Retrieves detailed information about a specific artist.
+Fetch detailed information about a specific artist.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSeveralArtists
-Retrieves detailed information about multiple artists in a single request.
+Get details for multiple artists in a single request.
+```javascript
+// Yet to provide example usage
+```
 
 ### getArtistsAlbums
-Retrieves the albums of a specific artist.
+List the albums of a specific artist.
+```javascript
+// Yet to provide example usage
+```
 
 ### getArtistTopTracks
-Retrieves the top tracks of a specific artist.
+Retrieve the top tracks of a specific artist.
+```javascript
+// Yet to provide example usage
+```
 
 ### getArtistsRelatedArtists
-Retrieves a list of artists related to a specific artist.
+Get a list of artists related to a specific artist.
+```javascript
+// Yet to provide example usage
+```
 
 ### getAudiobook
-Retrieves detailed information about a specific audiobook.
+Get detailed information about a specific audiobook.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSeveralAudiobooks
-Retrieves detailed information about multiple audiobooks in a single request.
+Retrieve details for multiple audiobooks in a single request.
+```javascript
+// Yet to provide example usage
+```
 
 ### getAudiobookChapters
-Retrieves the chapters of a specific audiobook.
+Fetch the chapters of a specific audiobook.
+```javascript
+// Yet to provide example usage
+```
 
 ### getUsersSavedAudiobooks
 Retrieves a list of audiobooks saved in the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### saveAudiobooksForCurrentUser
 Saves one or more audiobooks to the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### removeUsersSavedAudiobooks
 Removes one or more audiobooks from the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### checkUsersSavedAudiobooks
 Checks if one or more audiobooks are saved in the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSeveralBrowseCategories
 Retrieves detailed information about multiple browse categories in a single request.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSingleBrowseCategory
 Retrieves detailed information about a specific browse category.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSingleChapter
 Retrieves detailed information about a specific chapter of an audiobook.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSeveralChapters
 Retrieves detailed information about multiple chapters of an audiobook in a single request.
+```javascript
+// Yet to provide example usage
+```
 
 ### getEpisode
 Retrieves detailed information about a specific episode of a show or podcast.
+```javascript
+// Yet to provide example usage
+```
 
 ### getSeveralEpisodes
 Retrieves detailed information about multiple episodes of shows or podcasts in a single request.
+```javascript
+// Yet to provide example usage
+```
 
 ### getUsersSavedEpisodes
 Retrieves a list of episodes saved in the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### saveEpisodesForCurrentUser
 Saves one or more episodes to the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### removeUsersSavedEpisodes
 Removes one or more episodes from the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### checkUsersSavedEpisodes
 Checks if one or more episodes are saved in the user's library.
+```javascript
+// Yet to provide example usage
+```
 
 ### getAvailableGenreSeeds
 Retrieves a list of available genre seeds for recommendations.
+```javascript
+// Yet to provide example usage
+```
 
@@ -151,0 +255,0 @@ ### getNext

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 3 instances in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 3 instances in 1 package

Improved metrics

Total package byte prevSize

137232

1.5%

Number of lines in readme file

443

30.68%

No dependency changes