Class QueryContext<T>

constructor

• new QueryContext<T>(
      entityType: Class<T> & { create?(model: Partial<T>): T },
      entityEndpoint: string,
  ): QueryContext<T>

  Type Parameters

  • T

  Parameters

  • entityType: Class<T> & { create?(model: Partial<T>): T }
  • entityEndpoint: string

  Returns QueryContext<T>

ReadonlyentityEndpoint

ReadonlyentityType

queryParams

applyExpansion

• applyExpansion(...navigationProperties: ExpandParameter<T>[]): this

  Parameters

  • ...navigationProperties: ExpandParameter<T>[]

  Returns this

applyFilter

• applyFilter(filterExpression: string | unknown[]): this

  Parameters

  • filterExpression: string | unknown[]

  Returns this

applyPaging

• applyPaging(pageSize: number): this

  Parameters

  • pageSize: number

  Returns this

applyProjection

• applyProjection(...columns: (keyof T)[]): this

  Parameters

  • ...columns: (keyof T)[]

  Returns this

applySorting

• applySorting(...sortOptions: SortOption<T>[]): this

  Parameters

  • ...sortOptions: SortOption<T>[]

  Returns this

applyTransformation

• applyTransformation(transform: unknown): this

  Parameters

  • transform: unknown

  Returns this

reset

• reset(): this

  Returns this

Staticcreate

• create<T>(entityType: Class<T>, customEndpoint?: string): QueryContext<T>

  Create a new query context.

  Type Parameters

  • T

  Parameters

  • entityType: Class<T>

    The type of the entity to query.

  • OptionalcustomEndpoint: string

    If the entity is part of a nested collection, this can be used to specify a custom endpoint that contains the parent entity id.

  Returns QueryContext<T>

  Example

  QueryContext.create(EmailAddressModel);
  QueryContext.create(EmailAddressModel, `${Endpoints.Users}(42)/EmailAddresses`);
  Copy

StaticgetEntityEndpoint

• getEntityEndpoint<T>(entityType: Class<T>): string

  Type Parameters

  • T

  Parameters

  • entityType: Class<T>

  Returns string

StaticregisterOdataEndpoint

• registerOdataEndpoint<T>(entityType: Class<T>, endpoint: string): void

  Type Parameters

  • T

  Parameters

  • entityType: Class<T>
  • endpoint: string

  Returns void