Skip to content

Latest commit

 

History

History
258 lines (151 loc) · 8.46 KB

Mongo_Transporter_for_Powership_.md

File metadata and controls

258 lines (151 loc) · 8.46 KB
Raw

Powership / Modules / Mongo Transporter for Powership.

Module: Mongo Transporter for Powership.

Table of contents

Classes

Interfaces

Type Aliases

Functions

Type Aliases

CacheContext

Ƭ CacheContext: Record<string, any>

Defined in

packages/mongo/src/mongoDataLoader/IMongoDataLoader.ts:4

MongoDataLoaderOptions

Ƭ MongoDataLoaderOptions: DataLoader.Options<MongoDataLoaderKey, any, string>

Defined in

packages/mongo/src/mongoDataLoader/IMongoDataLoader.ts:16

ParsedMongoDLParams

Ƭ ParsedMongoDLParams: ReturnType<typeof parseMongoDLParams>

Defined in

packages/mongo/src/mongoDataLoader/parseMongoDLParams.ts:7

Functions

createMongoIndexBasedFilters

▸ createMongoIndexBasedFilters(options): Query<any>[]

Parameters

Name Type
options Object
options.filter IndexFilterRecord<string, string>
options.indexConfig AnyCollectionIndexConfig

Returns

Query<any>[]

Defined in

packages/transporter/out/parseAggioAttributeFilters.d.ts:4

getMongoDataloader

▸ getMongoDataloader(cacheContext, dataloaderHash): MongoDataLoader

Parameters

Name Type
cacheContext CacheContext
dataloaderHash string

Returns

MongoDataLoader

Defined in

packages/mongo/src/mongoDataLoader/getMongoDataloader.ts:7

isObjectId

▸ isObjectId(input): input is ObjectId

Parameters

Name Type
input any

Returns

input is ObjectId

Defined in

packages/mongo/src/mongoDataLoader/parseMongoDLParams.ts:45

mongoFindMany

▸ mongoFindMany(options, context?): Promise<DocumentBase[]>

Parameters

Name Type
options MongoFindManyParams
context? null | CacheContext

Returns

Promise<DocumentBase[]>

Defined in

packages/mongo/src/mongoDataLoader/mongoFindMany.ts:47

mongoLoadById

▸ mongoLoadById(options, cacheContext): Promise<DocumentBase[]>

Parameters

Name Type
options Omit<MongoFindManyParams, "sort" | "query" | "onlyOne"> & { id: any }
cacheContext CacheContext

Returns

Promise<DocumentBase[]>

Defined in

packages/mongo/src/mongoDataLoader/mongoFindMany.ts:8

mongoLoadByIds

▸ mongoLoadByIds(options, cacheContext): Promise<DocumentBase[][]>

Parameters

Name Type
options Omit<MongoFindManyParams, "sort" | "query" | "onlyOne"> & { ids: any[] }
cacheContext CacheContext

Returns

Promise<DocumentBase[][]>

Defined in

packages/mongo/src/mongoDataLoader/mongoFindMany.ts:26

parseMongoAttributeFilters

▸ parseMongoAttributeFilters(attFilter): Query<any>[]

Parameters

Name Type
attFilter FilterRecord<DocumentBase>

Returns

Query<any>[]

Defined in

packages/transporter/out/parseAggioAttributeFilters.d.ts:8

parseMongoDLParams

▸ parseMongoDLParams(options): Object

Parameters

Name Type
options MongoFindManyParams

Returns

Object

Name Type
_isParsed boolean
dataLoaderKey MongoDataLoaderKey
dataloaderHash string
queryHash string

Defined in

packages/mongo/src/mongoDataLoader/parseMongoDLParams.ts:9

parseMongoUpdateExpression

▸ parseMongoUpdateExpression(operations): UpdateDefinition<any> | UpdateDefinition<any>[]

Parameters

Name Type
operations ({ entries: [string, undefined | Record<string, undefined | number>][] ; operator: "$inc" ; valueConstructorName: string } | { entries: [string, undefined | {}][] ; operator: "$addToSet" ; valueConstructorName: string } | { entries: [string, undefined | {}][] ; operator: "$append" ; valueConstructorName: string } | { entries: [string, undefined | {}][] ; operator: "$prepend" ; valueConstructorName: string } | { entries: [string, undefined | {}][] ; operator: "$pull" ; valueConstructorName: string } | { entries: [string, undefined | MaybeArray<string>][] ; operator: "$remove" ; valueConstructorName: string } | { entries: [string, undefined | Readonly<{} & {} & {}>][] ; operator: "$set" ; valueConstructorName: string } | { entries: [string, undefined | Readonly<{} & {} & {}>][] ; operator: "$setIfNull" ; valueConstructorName: string } | { entries: [string, undefined | Readonly<{} & {} & {}>][] ; operator: "$setOnInsert" ; valueConstructorName: string })[]

Returns

UpdateDefinition<any> | UpdateDefinition<any>[]

Defined in

packages/transporter/out/parseAggioUpdateExpression.d.ts:3