Class QuerySourceHypermedia

constructor

• new QuerySourceHypermedia(
      cacheSize: number,
      firstUrl: string,
      forceSourceType: undefined | string,
      maxIterators: number,
      aggregateStore: boolean,
      mediators: IMediatorArgs,
      logWarning: (warningMessage: string) => void,
      dataFactory: ComunicaDataFactory,
      bindingsFactory: BindingsFactory,
  ): QuerySourceHypermedia

  Parameters

  • cacheSize: number
  • firstUrl: string
  • forceSourceType: undefined | string
  • maxIterators: number
  • aggregateStore: boolean
  • mediators: IMediatorArgs
  • logWarning: (warningMessage: string) => void
  • dataFactory: ComunicaDataFactory
  • bindingsFactory: BindingsFactory

  Returns QuerySourceHypermedia

ReadonlyaggregateStore

ReadonlybindingsFactory

ReadonlydataFactory

ReadonlyfirstUrl

Optional ReadonlyforceSourceType

ReadonlylogWarning

Readonlymediators

ReadonlyreferenceValue

sourcesState

getAggregateStore

• getAggregateStore(context: IActionContext): undefined | IAggregatedStore<Quad>

  Parameters

  • context: IActionContext

  Returns undefined | IAggregatedStore<Quad>

getSelectorShape

• getSelectorShape(context: IActionContext): Promise<FragmentSelectorShape>

  Get the selector type that is supported by this source.

  Parameters

  • context: IActionContext

    The action context.

  Returns Promise<FragmentSelectorShape>

getSource

• getSource(
      link: ILink,
      handledDatasets: Record<string, boolean>,
      context: IActionContext,
      aggregatedStore: undefined | IAggregatedStore<Quad>,
  ): Promise<ISourceState>

  Resolve a source for the given URL.

  Parameters

  • link: ILink

    A source link.
  • handledDatasets: Record<string, boolean>

    A hash of dataset identifiers that have already been handled.
  • context: IActionContext

    The action context.
  • aggregatedStore: undefined | IAggregatedStore<Quad>

    An optional aggregated store.

  Returns Promise<ISourceState>

queryBindings

• queryBindings(
      operation: Operation,
      context: IActionContext,
      options?: IQueryBindingsOptions,
  ): BindingsStream

  Returns a (possibly lazy) stream that returns all bindings matching the operation.

  Passed operations MUST conform to the query shape exposed by the selector type returned from getSelectorShape. The given operation represents a Linked Data Fragments selector.

  The returned stream MUST expose the property 'metadata' of type MetadataBindings. The implementor is reponsible for handling cases where 'metadata' is being called without the stream being in flow-mode. This metadata object can become invalidated (see metadata.state), in which case the 'metadata' property must and will be updated.

  Parameters

  • operation: Operation

    The query operation to execute.
  • context: IActionContext

    The query context.
  • Optionaloptions: IQueryBindingsOptions

    Options for querying bindings

  Returns BindingsStream

  The resulting bindings stream.

  See

  https://linkeddatafragments.org/specification/linked-data-fragments/#selectors

queryBoolean

• queryBoolean(operation: Ask, context: IActionContext): Promise<boolean>

  Returns a promise resolving to the ask response of the given operation.

  This method should only be supported if the selector type returned from getSelectorShape supports ask queries.

  Parameters

  • operation: Ask

    The query operation to execute.
  • context: IActionContext

    The query context.

  Returns Promise<boolean>

  The resulting ask reply.

queryQuads

• queryQuads(operation: Operation, context: IActionContext): AsyncIterator<Quad>

  Returns a (possibly lazy) stream that returns all quads matching the operation.

  This method should only be supported if the selector type returned from getSelectorShape supports construct queries.

  Parameters

  • operation: Operation

    The query operation to execute.
  • context: IActionContext

    The query context.

  Returns AsyncIterator<Quad>

  The resulting quads stream.

queryVoid

• queryVoid(operation: Update, context: IActionContext): Promise<void>

  Returns a promise resolving when the given update operation succeeds.

  This method should only be supported if the selector type returned from getSelectorShape supports update queries.

  Parameters

  • operation: Update

    The query operation to execute.
  • context: IActionContext

    The query context.

  Returns Promise<void>

  The void response.

toString

• toString(): string

  Returns a string representation of this source.

  Returns string