smartdata/dist/smartdata.classes.dbcollection.d.ts

42 lines
1.2 KiB
TypeScript

import * as plugins from './smartdata.plugins';
import { Db } from './smartdata.classes.db';
import { DbDoc } from './smartdata.classes.dbdoc';
export interface IFindOptions {
limit?: number;
}
export interface IDocValidation<T> {
(doc: T): boolean;
}
export declare function Collection(db: Db): (constructor: any) => void;
export declare class DbTable<T> {
/**
* the collection that is used, defaults to mongodb collection,
* can be nedb datastore (sub api of mongodb)
*/
table: plugins.rethinkDb.Table;
objectValidation: IDocValidation<T>;
name: string;
db: Db;
constructor(collectedClassArg: T & DbDoc<T>, dbArg: Db);
/**
* adds a validation function that all newly inserted and updated objects have to pass
*/
addDocValidation(funcArg: IDocValidation<T>): void;
/**
* finds an object in the DbCollection
*/
find(docMatchArg: T | any, optionsArg?: IFindOptions): Promise<T[]>;
/**
* inserts object into the DbCollection
*/
insertOne(docArg: T): Promise<void>;
/**
* inserts many objects at once into the DbCollection
*/
insertMany(docArrayArg: T[]): Promise<void>;
/**
* checks a Doc for constraints
*/
private checkDoc(docArg);
}