43 lines
1.3 KiB
TypeScript
43 lines
1.3 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 DbCollection<T> {
|
||
|
|
/**
|
||
|
|
* the collection that is used, defaults to mongodb collection,
|
||
|
|
* can be nedb datastore (sub api of mongodb)
|
||
|
|
*/
|
||
|
|
collection: plugins.mongodb.Collection;
|
||
|
|
collectedClass: T & DbDoc<T>;
|
||
|
|
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);
|
||
|
|
}
|