Class FilterFactory

Hierarchy

FilterFactory

Index

Constructors

Methods

getPreviousPeriodFilter makeForeignFilter makeThroughFilter

Constructors

constructor

new FilterFactory(): FilterFactory
Returns FilterFactory

Methods

`Static` getPreviousPeriodFilter

getPreviousPeriodFilter(filter: Filter, timezone: string): Filter
Parameters
- filter: Filter
- timezone: string
Returns Filter
- Defined in packages/datasource-toolkit/src/interfaces/query/filter/factory.ts:42

`Static` makeForeignFilter

makeForeignFilter(collection: Collection, id: CompositeId, relationName: string, caller: Caller, baseForeignFilter: PaginatedFilter): Promise<Filter>
Given a collection and a OneToMany/ManyToMany relation, generate a filter which
- match only children of the provided recordId
- can apply on the target collection of the relation
Parameters
- collection: Collection
- id: CompositeId
- relationName: string
- caller: Caller
- baseForeignFilter: PaginatedFilter
Returns Promise<Filter>
- Defined in packages/datasource-toolkit/src/interfaces/query/filter/factory.ts:168

`Static` makeThroughFilter

makeThroughFilter(collection: Collection, id: CompositeId, relationName: string, caller: Caller, baseForeignFilter: PaginatedFilter): Promise<PaginatedFilter>
Make a filter targeting the through collection of a many to many relationship from the relation and a filter to the target collection.
Parameters
- collection: Collection
- id: CompositeId
- relationName: string
- caller: Caller
- baseForeignFilter: PaginatedFilter
Returns Promise<PaginatedFilter>
- Defined in packages/datasource-toolkit/src/interfaces/query/filter/factory.ts:98