doc: Add an example which instantiates the client with app info

kellnerd · Mar 30, 2024 · d1f14a2 · d1f14a2
1 parent 454af7e
commit d1f14a2
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/client.ts b/client.ts
@@ -79,6 +79,17 @@ export class MusicBrainzClient {
    *
    * You should identify your application to avoid being blocked:
    * https://wiki.musicbrainz.org/MusicBrainz_API/Rate_Limiting
+   *
+   * @example
+   * ```ts
+   * const client = new MusicBrainzClient({
+   *   app: {
+   *     name: "ExampleApp",
+   *     version: "1.2.3",
+   *     contact: "http://example.com/app",
+   *   },
+   * });
+   * ```
    */
   constructor(options: ClientOptions = {}) {
     this.apiBaseUrl = options.apiUrl ?? "https://musicbrainz.org/ws/2/";