Module mongo

Index

Interfaces

Type aliases

Functions

Type aliases

MongoConnector

MongoConnector<TDocument>: Connector<TDocument, Filter<TDocument>, Pick<QueryOptions, "skip" | "limit">, Collection<TDocument>>

Type parameters

TDocument = any

MongooseConnector

MongooseConnector<TModel>: Connector<TModel, FilterQuery<TModel>, QueryOptions, mongoose.Model<any, any>>

Type parameters

TModel = any

Functions

Const createMongoConnector

createMongoConnector<TDocument>(model: VulcanModel<VulcanSchema<AnyObject>>, options: MongoConnectorOptions): MongoConnector<TDocument>

- Defined in packages/mongo/mongoConnector.ts:45
Type parameters
- TDocument = any
Parameters
- model: VulcanModel<VulcanSchema<AnyObject>>
- options: MongoConnectorOptions
Returns MongoConnector<TDocument>

Const createMongooseConnector

createMongooseConnector<TModel>(model: VulcanModel<VulcanSchema<AnyObject>>, options?: MongooseConnectorOptions): MongooseConnector<TModel>

- Defined in packages/mongo/mongooseConnector.ts:34
Will be deprecated @see https://github.com/VulcanJS/vulcan-npm/pull/129

Type parameters
- TModel = any
Parameters
- model: VulcanModel<VulcanSchema<AnyObject>>
- Optional options: MongooseConnectorOptions
Returns MongooseConnector<TModel>

Const filterFunction

filterFunction(model: VulcanModel<VulcanSchema<AnyObject>>, input: FilterableInput<any>, context?: any): Promise<FilterFunctionOutput>

- Defined in packages/mongo/mongoParams.ts:86
Parameters
- model: VulcanModel<VulcanSchema<AnyObject>>
- input: FilterableInput<any>
- Optional context: any
Returns Promise<FilterFunctionOutput>

Generated using TypeDoc