Options
All
  • Public
  • Public/Protected
  • All
Menu

Module context-entries

Comunica Context Entries

npm version

A collection of reusable Comunica context key definitions.

This module is part of the Comunica framework, and should only be used by developers that want to build their own query engine.

Click here if you just want to query with Comunica.

Install

$ yarn add @comunica/context-entries

Usage

import { KeysInitSparql } from '@comunica/context-entries';

// ...

const baseIRI = context.get(KeysInitSparql.baseIRI);

All available keys are available in Keys.

Index

Variables

Const KeysCore

KeysCore: { log: ActionContextKey<Logger> } = ...

When adding entries to this file, also add a shortcut for them in the contextKeyShortcuts TSDoc comment in ActorIniQueryBase in @comunica/actor-init-query if it makes sense to use this entry externally. Also, add this shortcut to IQueryContextCommon in @comunica/types.

Type declaration

Const KeysHttp

KeysHttp: { auth: ActionContextKey<string>; fetch: ActionContextKey<(input: RequestInfo | URL, init?: RequestInit) => Promise<Response>>; httpBodyTimeout: ActionContextKey<boolean>; httpTimeout: ActionContextKey<number>; includeCredentials: ActionContextKey<boolean> } = ...

Type declaration

Const KeysHttpMemento

KeysHttpMemento: { datetime: ActionContextKey<Date> } = ...

Type declaration

Const KeysHttpProxy

KeysHttpProxy: { httpProxyHandler: ActionContextKey<IProxyHandler> } = ...

Type declaration

Const KeysInitQuery

KeysInitQuery: { baseIRI: ActionContextKey<string>; cliArgsHandlers: ActionContextKey<ICliArgsHandler[]>; explain: ActionContextKey<QueryExplainMode>; extensionFunctionCreator: ActionContextKey<(functionNamedNode: NamedNode<string>) => undefined | ((args: Term[]) => Promise<Term>)>; extensionFunctions: ActionContextKey<Record<string, (args: Term[]) => Promise<Term>>>; graphqlSingularizeVariables: ActionContextKey<any>; initialBindings: ActionContextKey<Bindings>; jsonLdContext: ActionContextKey<any>; lenient: ActionContextKey<boolean>; physicalQueryPlanLogger: ActionContextKey<IPhysicalQueryPlanLogger>; physicalQueryPlanNode: ActionContextKey<any>; query: ActionContextKey<Operation>; queryFormat: ActionContextKey<QueryFormat>; queryString: ActionContextKey<string>; queryTimestamp: ActionContextKey<Date> } = ...

Type declaration

Const KeysQueryOperation

KeysQueryOperation: { isPathArbitraryLengthDistinctKey: ActionContextKey<boolean>; joinBindings: ActionContextKey<Bindings>; joinLeftMetadata: ActionContextKey<MetadataBindings>; joinRightMetadatas: ActionContextKey<MetadataBindings[]>; limitIndicator: ActionContextKey<number>; operation: ActionContextKey<string>; readOnly: ActionContextKey<boolean>; unionDefaultGraph: ActionContextKey<boolean> } = ...

Type declaration

Const KeysRdfParseHtmlScript

KeysRdfParseHtmlScript: { extractAllScripts: ActionContextKey<boolean>; processingHtmlScript: ActionContextKey<boolean> } = ...

Type declaration

Const KeysRdfParseJsonLd

KeysRdfParseJsonLd: { documentLoader: ActionContextKey<IDocumentLoader>; parserOptions: ActionContextKey<Record<string, any>>; strictValues: ActionContextKey<boolean> } = ...

Type declaration

Const KeysRdfResolveQuadPattern

KeysRdfResolveQuadPattern: { source: ActionContextKey<IDataSource>; sourceIds: ActionContextKey<Map<IDataSource, string>>; sources: ActionContextKey<DataSources> } = ...

Type declaration

Const KeysRdfUpdateQuads

KeysRdfUpdateQuads: { destination: ActionContextKey<IDataDestination> } = ...

Type declaration

Generated using TypeDoc