gypsum/models/file-model/collection.d.ts

Simple and easy lightweight typescript server side framework on Node.js.

import * as Validall from 'validall';
import { Logger } from '../../misc/logger';
export declare namespace FileCollection {
    interface Document {
        _id: string;
        [key: string]: any;
    }
    interface IFindOptions {
        skip?: number;
        limit?: number;
    }
    interface IUpdateOptions {
        multi: boolean;
        returnDoc?: boolean;
    }
    interface IDeleteOptions {
        limit?: number;
        returnDoc?: boolean;
    }
    interface ICollectionOptions {
        findOptions?: IFindOptions;
        updateOptions?: IUpdateOptions;
        deleteOptions?: IDeleteOptions;
    }
}
export interface IFileData {
    indexes: string[];
    documents: FileCollection.Document[];
}
export declare class FileCollection {
    protected filename: string;
    protected filePath: string;
    protected schema: Validall.Schema | null;
    protected findOptions: FileCollection.IFindOptions;
    protected updateOptions: FileCollection.IUpdateOptions;
    protected deleteOptions: FileCollection.IDeleteOptions;
    logger: Logger;
    constructor(name: string, schema?: Validall.Schema, options?: FileCollection.ICollectionOptions);
    protected read(): Promise<IFileData>;
    protected write(data: IFileData): Promise<boolean>;
    find(query: Validall.ISchema, projection?: string, options?: FileCollection.IFindOptions): Promise<FileCollection.Document[]>;
    findById(id: string, projection?: string): Promise<FileCollection.Document>;
    findOne(query: Validall.ISchema, projection?: string): Promise<FileCollection.Document>;
    count(query: Validall.ISchema): Promise<number>;
    insert(documents: any[]): Promise<FileCollection.Document[]>;
    update(filter: Validall.ISchema, update: any, options?: FileCollection.IUpdateOptions, single?: boolean): Promise<FileCollection.Document | FileCollection.Document[] | number>;
    updateById(id: string, update: any): Promise<FileCollection.Document | null>;
    updateOne(filter: Validall.ISchema, update: any): Promise<FileCollection.Document | null>;
    delete(filter: Validall.ISchema, options?: FileCollection.IDeleteOptions): Promise<FileCollection.Document[] | number>;
    deleteById(id: string): Promise<FileCollection.Document>;
    deleteOne(filter: Validall.ISchema): Promise<FileCollection.Document>;
}