chore: build

Author: tharropoulos

dist/typesense.js

@@ -4,7 +4,23 @@ export default class Alias {
     private name;
     private apiCall;
     constructor(name: string, apiCall: ApiCall);
+    /**
+     * Find out which collection an alias points to by fetching it
+     *
+     * @example
+     * await client.aliases("my-alias").retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#retrieve-an-alias
+     */
     retrieve(): Promise<CollectionAliasSchema>;
+    /**
+     * Delete an alias
+     *
+     * @example
+     * await client.aliases("my-alias").delete()
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#delete-an-alias
+     */
     delete(): Promise<CollectionAliasSchema>;
     private endpointPath;
 }

dist/typesense.js.map

@@ -11,7 +11,23 @@ export interface CollectionAliasesResponseSchema {
 export default class Aliases {
     private apiCall;
     constructor(apiCall: ApiCall);
+    /**
+     * Create or update a collection alias.
+     *
+     * @example
+     * await client.aliases().upsert("my-alias", { collection_name: "products" })
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#create-or-update-an-alias
+     */
     upsert(name: string, mapping: CollectionAliasCreateSchema): Promise<CollectionAliasSchema>;
+    /**
+     * List all aliases and the corresponding collections that they map to.
+     *
+     * @example
+     * await client.aliases().retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#list-all-aliases
+     */
     retrieve(): Promise<CollectionAliasesResponseSchema>;
     private endpointPath;
     static get RESOURCEPATH(): string;