fix(sdk): AlwatrStorage class name

Alwatr · Nov 27, 2023 · 7e0d238 · 7e0d238
1 parent 1da2a32
commit 7e0d238
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/packages/sdk/src/storage-sdk.ts b/packages/sdk/src/storage-sdk.ts
@@ -1,15 +1,15 @@
 import {type FetchOptions, serviceRequest} from '@alwatr/fetch';
 import {createLogger, definePackage} from '@alwatr/logger';
 
-import type {AlwatrStorageClientConfig} from './type.js';
+import type {AlwatrStorageConfig} from './type.js';
 import type {
   AlwatrDocumentObject,
   AlwatrDocumentStorage,
   AlwatrServiceResponseSuccess,
   StringifyableRecord,
 } from '@alwatr/type';
 
-export {type AlwatrStorageClientConfig};
+export {type AlwatrStorageConfig};
 
 definePackage('@alwatr/storage-sdk', '4.*');
 
@@ -19,7 +19,7 @@ definePackage('@alwatr/storage-sdk', '4.*');
  * Example:
  *
  * ```ts
- * import {type AlwatrDocumentObject, AlwatrStorageClient} from '@alwatr/storage-sdk';
+ * import {type AlwatrDocumentObject, AlwatrStorage} from '@alwatr/storage-sdk';
  *
  * interface User extends AlwatrDocumentObject  {
  *   fname: string;
@@ -28,7 +28,7 @@ definePackage('@alwatr/storage-sdk', '4.*');
  *   token?: string;
  * }
  *
- * const db = new AlwatrStorageClient<User>({
+ * const db = new AlwatrStorage<User>({
  *   name: 'user-list',
  *   host: 'http://127.0.0.1:80',
  *   token: 'YOUR_SECRET_TOKEN',
@@ -61,7 +61,7 @@ definePackage('@alwatr/storage-sdk', '4.*');
  *   console.log('delete 404: %o', (err as Error).message);
  * }
  */
-export class AlwatrStorageClient<DocumentType extends AlwatrDocumentObject = AlwatrDocumentObject> {
+export class AlwatrStorage<DocumentType extends AlwatrDocumentObject = AlwatrDocumentObject> {
   protected _logger = createLogger(
     'alwatr/storage-sdk' + (this.config.name == null ? '' : ':' + this.config.name),
     this.config.devMode,
@@ -81,7 +81,7 @@ export class AlwatrStorageClient<DocumentType extends AlwatrDocumentObject = Alw
     token: this.config.token,
   };
 
-  constructor(public readonly config: AlwatrStorageClientConfig) {
+  constructor(public readonly config: AlwatrStorageConfig) {
     this._logger.logMethodArgs?.('constructor', config);
   }
 

diff --git a/packages/sdk/src/type.ts b/packages/sdk/src/type.ts
@@ -1,4 +1,4 @@
-export interface AlwatrStorageClientConfig {
+export interface AlwatrStorageConfig {
   /**
    * Storage name (like database name).
    */