docs(artistsapi.ts): add code example for 'getArtist'

adamgrieger · Jun 27, 2020 · 04bdc69 · 04bdc69
1 parent ca8bb89
commit 04bdc69
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/apis/ArtistsApi.ts b/src/apis/ArtistsApi.ts
@@ -16,11 +16,18 @@ export class ArtistsApi {
   }
 
   /**
-   * Get an Artist
+   * ### Get an Artist
    *
    * Get Spotify catalog information for a single artist identified by their
    * unique Spotify ID.
    *
+   * @example
+   * ```ts
+   * const artist = await spotify.artists.getArtist('4Ge8xMJNwt6EEXOzVXju9a');
+   * console.log(artist.name);
+   * // "Caroline Polachek"
+   * ```
+   *
    * @param artistId The Spotify ID for the artist.
    */
   getArtist(artistId: string): Promise<Artist> {