Class IncludeClauseTool

Include clause tool.

Hierarchy

Service
- IncludeClauseTool

Index

Constructors

Properties

Methods

addService getService hasService includeTo useService normalizeIncludeClause normalizeScopeClause validateIncludeClause validateScopeClause

Constructors

constructor

new IncludeClauseTool(container?): IncludeClauseTool
Constructor.
Parameters
- Optional container: ServiceContainer
Returns IncludeClauseTool
Inherited from Service.constructor
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:18

Properties

container

container: ServiceContainer

Container.

Methods

addService

addService<T>(ctor, ...args): this
Add service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
- Rest ...args: any[]
Returns this
Inherited from Service.addService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:46

getService

getService<T>(ctor, ...args): T
Get service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
- Rest ...args: any[]
Returns T
Inherited from Service.getService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:26

hasService

hasService<T>(ctor): boolean
Has service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
Returns boolean
Inherited from Service.hasService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:36

includeTo

includeTo(entities, modelName, clause): Promise<void>
Include to.
Parameters
- entities: ModelData[]
- modelName: string
- clause: undefined | string | NestedIncludeClause | NormalizedIncludeClause | IncludeClause[]
Returns Promise<void>
- Defined in src/filter/include-clause-tool.d.ts:18

useService

useService<T>(ctor, ...args): this
Use service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
- Rest ...args: any[]
Returns this
Inherited from Service.useService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:57

`Static` normalizeIncludeClause

normalizeIncludeClause(clause): NormalizedIncludeClause[]
Normalize include clause.
Parameters
- clause: undefined | string | NestedIncludeClause | NormalizedIncludeClause | IncludeClause[]
Returns NormalizedIncludeClause[]
- Defined in src/filter/include-clause-tool.d.ts:43

`Static` normalizeScopeClause

normalizeScopeClause(clause): undefined | FilterClause
Normalize scope clause.
Parameters
- clause: undefined | FilterClause
Returns undefined | FilterClause
- Defined in src/filter/include-clause-tool.d.ts:52

`Static` validateIncludeClause

validateIncludeClause(clause): void
Validate include clause.
Parameters
- clause: undefined | string | NestedIncludeClause | NormalizedIncludeClause | IncludeClause[]
Returns void
- Defined in src/filter/include-clause-tool.d.ts:29

`Static` validateScopeClause

validateScopeClause(clause): void
Validate scope clause.
Parameters
- clause: undefined | FilterClause
Returns void
- Defined in src/filter/include-clause-tool.d.ts:36

Generated using TypeDoc