javascript-ampache 1.0.9 → 1.1.0

package/README.md

@@ -1,47 +1,50 @@
-# javascript-ampache
-
-A JS client for the Ampache API written in Typescript.
-
-## Installation
-
-```bash
-npm install javascript-ampache
-```
-
-## Usage
-
-Import `javascript-ampache` module in your project and initialize it with the URL to your server e.g. http://music.com.au
-
-```js
-import AmpacheAPI from 'javascript-ampache';
-
-const API = new AmpacheAPI({ url: 'http://pathToYourAmpacheServer', sessionKey: yourSessionAuthKey }); // debug: true - will log the final GET to console
-
-// either set the session key at time of instantiation or set/update with: 
-API.setSessionKey(yourSessionAuthKey);
-
-let allUsers = API.users();
-
-let thisAlbum = API.album({ filter: 123 });
-
-let results = API.advancedSearch({
-    type: "album",
-    operator: "and",
-    random: 1,
-    limit: 20,
-    rules: [
-        ['title', 0, 'monkey'], // Title contains 'monkey'
-        ['myrating', 2, 4] // Rating is 4 stars
-    ]
-});
-```
-
-## Build
-```bash
-npm run build
-```
-
-### Special thanks
-https://lyamkin.com/blog/how-to-build-api-client-library-in-js/ & https://github.com/ilyamkin/dev-to-js
-
-
+# javascript-ampache
+
+A JS client for the Ampache API written in Typescript.
+
+## Installation
+
+```bash
+npm install javascript-ampache
+```
+
+## Usage
+
+Import `javascript-ampache` module in your project and initialize it with the URL to your server e.g. http://music.com.au
+
+```js
+import AmpacheAPI from "javascript-ampache";
+
+const API = new AmpacheAPI({
+  url: "http://pathToYourAmpacheServer",
+  sessionKey: yourSessionAuthKey,
+}); // debug: true - will log the final GET to console
+
+// either set the session key at time of instantiation or set/update with:
+API.setSessionKey(yourSessionAuthKey);
+
+let allUsers = API.users();
+
+let thisAlbum = API.album({ filter: 123 });
+
+let results = API.advancedSearch({
+  type: "album",
+  operator: "and",
+  random: 1,
+  limit: 20,
+  rules: [
+    ["title", 0, "monkey"], // Title contains 'monkey'
+    ["myrating", 2, 4], // Rating is 4 stars
+  ],
+});
+```
+
+## Build
+
+```bash
+npm run build
+```
+
+### Special thanks
+
+https://lyamkin.com/blog/how-to-build-api-client-library-in-js/ & https://github.com/ilyamkin/dev-to-js

package/dist/base.d.ts

@@ -35,6 +35,11 @@ export declare abstract class Base {
     protected request<T>(endpoint: string): Promise<T>;
     protected binary<T>(endpoint: string): Promise<Blob>;
     setSessionKey(sessionKey: string): void;
+    /**
+     * Construct and return a URL
+     * @param endpoint
+     * @param [params]
+     */
     rawURL(endpoint: string, params?: {}): string;
 }
 export {};