Class RemoteEdgeQueryContext<T>

constructor

• new RemoteEdgeQueryContext<T extends Unknown = Unknown>(
      _params: RemoteEdgeQueryContextParams,
  ): RemoteEdgeQueryContext<T>

  Type Parameters

  • T extends Unknown = Unknown

  Parameters

  • _params: RemoteEdgeQueryContextParams

  Returns RemoteEdgeQueryContext<T>

Readonlychanged

getCompleteness

• getCompleteness(): Completeness

  How much of the answer getResults holds; see QueryResult.Completeness.

  Returns Completeness

getResults

• getResults(): EntityEntry<T>[]

  Returns EntityEntry<T>[]

getSourceStates

• getSourceStates(): SourceState[]

  Per-source progress on the current query.

  Returns SourceState[]

hasPendingSources

• hasPendingSources(): boolean

  Whether a source serving the current query has yet to answer, so getResults is only the part of the result the sources that have answered know about.

  Returns boolean

isSynchronous

• isSynchronous(): boolean

  Whether the current query is served by at least one synchronous source. False when the query is served only by asynchronous sources (e.g. a feed query served by the index), so callers can defer the initial subscription event until real results arrive instead of emitting an empty snapshot.

  Returns boolean

run

• run(
      _ctx: Context,
      query:
          | QuerySelectClause
          | QueryFilterClause
          | QueryReferenceTraversalClause
          | QueryIncomingReferencesClause
          | QueryRelationClause
          | QueryRelationTraversalClause
          | QueryHierarchyTraversalClause
          | QueryUnionClause
          | QuerySetDifferenceClause
          | QueryOrderClause
          | QueryOptionsClause
          | QueryLimitClause
          | QuerySkipClause
          | QueryAggregateClause
          | QueryFromClause,
      opts?: RunOptions,
  ): Promise<EntityEntry<T>[]>

  One-shot query.

  Parameters

  • _ctx: Context
  • query:
        | QuerySelectClause
        | QueryFilterClause
        | QueryReferenceTraversalClause
        | QueryIncomingReferencesClause
        | QueryRelationClause
        | QueryRelationTraversalClause
        | QueryHierarchyTraversalClause
        | QueryUnionClause
        | QuerySetDifferenceClause
        | QueryOrderClause
        | QueryOptionsClause
        | QueryLimitClause
        | QuerySkipClause
        | QueryAggregateClause
        | QueryFromClause
  • Optionalopts: RunOptions

  Returns Promise<EntityEntry<T>[]>

start

• start(): void

  Start creating query sources and firing events.

  start and stop are re-entrant.

  Returns void

stop

• stop(): void

  Clear any resources associated with the query.

  start and stop are re-entrant.

  Returns void

update

• update(
      query:
          | QuerySelectClause
          | QueryFilterClause
          | QueryReferenceTraversalClause
          | QueryIncomingReferencesClause
          | QueryRelationClause
          | QueryRelationTraversalClause
          | QueryHierarchyTraversalClause
          | QueryUnionClause
          | QuerySetDifferenceClause
          | QueryOrderClause
          | QueryOptionsClause
          | QueryLimitClause
          | QuerySkipClause
          | QueryAggregateClause
          | QueryFromClause,
  ): void

  Set the filter and trigger continuous updates.

  Parameters

  • query:
        | QuerySelectClause
        | QueryFilterClause
        | QueryReferenceTraversalClause
        | QueryIncomingReferencesClause
        | QueryRelationClause
        | QueryRelationTraversalClause
        | QueryHierarchyTraversalClause
        | QueryUnionClause
        | QuerySetDifferenceClause
        | QueryOrderClause
        | QueryOptionsClause
        | QueryLimitClause
        | QuerySkipClause
        | QueryAggregateClause
        | QueryFromClause

  Returns void