git-documentdb/dist/types_collection.d.ts

Offline-first database that syncs with Git

/**
 * GitDocumentDB
 * Copyright (c) Hidekazu Kubota
 *
 * This source code is licensed under the Mozilla Public License Version 2.0
 * found in the LICENSE file in the root directory of this source tree.
 */
import { CollectionOptions, CollectionPath } from './types';
import { CRUDInterface } from './types_crud_interface';
import { SyncEventInterface } from './types_sync';
/**
 * Type for Collection Class
 *
 * @public
 */
export declare type ICollection = CollectionInterface & CRUDInterface & SyncEventInterface & {
    /***********************************************
     * Public properties (readonly)
     ***********************************************/
    options: CollectionOptions;
    collectionPath: string;
    parent: ICollection | undefined;
    /***********************************************
     * Public methods
     ***********************************************/
    generateId(seedTime?: number): string;
};
/**
 * Interface for Collection
 *
 * @public
 */
export interface CollectionInterface {
    collection(collectionPath: CollectionPath, options?: CollectionOptions): ICollection;
    getCollections(dirPath: string): Promise<ICollection[]>;
}
//# sourceMappingURL=types_collection.d.ts.map