NodeCrud.d.ts 1.3 KB

1234567891011121314151617181920212223
  1. import type { FsPromisesApi } from '../node/types';
  2. import type * as crud from '../crud/types';
  3. export interface NodeCrudOptions {
  4. readonly fs: FsPromisesApi;
  5. readonly dir: string;
  6. readonly separator?: string;
  7. }
  8. export declare class NodeCrud implements crud.CrudApi {
  9. protected readonly options: NodeCrudOptions;
  10. protected readonly fs: FsPromisesApi;
  11. protected readonly dir: string;
  12. protected readonly separator: string;
  13. constructor(options: NodeCrudOptions);
  14. protected checkDir(collection: crud.CrudCollection): Promise<string>;
  15. readonly put: (collection: crud.CrudCollection, id: string, data: Uint8Array, options?: crud.CrudPutOptions) => Promise<void>;
  16. readonly get: (collection: crud.CrudCollection, id: string) => Promise<Uint8Array>;
  17. readonly del: (collection: crud.CrudCollection, id: string, silent?: boolean) => Promise<void>;
  18. readonly info: (collection: crud.CrudCollection, id?: string) => Promise<crud.CrudResourceInfo>;
  19. readonly drop: (collection: crud.CrudCollection, silent?: boolean) => Promise<void>;
  20. readonly scan: (collection: crud.CrudCollection) => AsyncIterableIterator<crud.CrudCollectionEntry>;
  21. readonly list: (collection: crud.CrudCollection) => Promise<crud.CrudCollectionEntry[]>;
  22. readonly from: (collection: crud.CrudCollection) => Promise<crud.CrudApi>;
  23. }