Interface SolidDataDriverOptions<T>

interface SolidDataDriverOptions<T> {
    baseIRI?: string;
    baseUri?: `http://${string}` | `https://${string}`;
    datetime?: Date;
    deserialize?: ((obj) => T);
    destination?: IDataDestination;
    engine?: ActorInitQueryBase<IQueryContextCommon>;
    explain?: QueryExplainMode;
    extensionFunctionCreator?: ((functionNamedNode) => ((args) => Promise<Term>));
    extensionFunctions?: Record<string, ((args) => Promise<Term>)>;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    functionArgumentsCache?: FunctionArgumentsCache;
    httpAuth?: `${string}:${string}`;
    httpBodyTimeout?: boolean;
    httpIncludeCredentials?: boolean;
    httpProxyHandler?: IProxyHandler;
    httpRetryCount?: number;
    httpRetryDelay?: number;
    httpRetryOnServerError?: boolean;
    httpTimeout?: number;
    initialBindings?: Bindings;
    lenient?: boolean;
    log?: Logger;
    queryFormat?: QueryFormat;
    queryTimestamp?: Date;
    readOnly?: boolean;
    recoverBrokenLinks?: boolean;
    serialize?: ((obj, baseURI?) => Readonly<{
        predicates: Readonly<Record<string, Readonly<Partial<{
            blankNodes: readonly ((...) | (...))[];
            langStrings: Readonly<Record<(...), (...)>>;
            literals: Readonly<Record<(...), (...)>>;
            namedNodes: readonly string[];
        }>>>>;
        type: "Subject";
        url: string;
    }>[]);
    source?: IDataSource;
    sources: [IDataSource, ...IDataSource[]];
    uid?: string;
    uriPrefix?: string;
}

Type Parameters

  • T

Hierarchy

  • SPARQLDriverOptions
    • SolidDataDriverOptions

Properties

baseIRI? baseUri? datetime? deserialize? destination? engine? explain? extensionFunctionCreator? extensionFunctions? fetch? functionArgumentsCache? httpAuth? httpBodyTimeout? httpIncludeCredentials? httpProxyHandler? httpRetryCount? httpRetryDelay? httpRetryOnServerError? httpTimeout? initialBindings? lenient? log? queryFormat? queryTimestamp? readOnly? recoverBrokenLinks? serialize? source? sources uid? uriPrefix?

Properties

Optional baseIRI

baseIRI?: string

The baseIRI for parsing the query.

Optional baseUri

baseUri?: `http://${string}` | `https://${string}`

Optional datetime

datetime?: Date

Optional deserialize

deserialize?: ((obj) => T)

Deserialize the RDF thing to instance

Type declaration

    • (obj): T

    • Parameters

      • obj: Readonly<{
            predicates: Readonly<Record<string, Readonly<Partial<{
                blankNodes: readonly (`_:${(...)}` | (Readonly<Record<string, Readonly<Partial<{ literals: Readonly<Record<string, readonly string[]>>; langStrings: Readonly<Record<string, readonly string[]>>; namedNodes: readonly string[]; blankNodes: readonly (`_:${string}` | Readonly<...>)[]; }>>>>))[];
                langStrings: Readonly<Record<string, readonly (...)[]>>;
                literals: Readonly<Record<string, readonly (...)[]>>;
                namedNodes: readonly string[];
            }>>>>;
            type: "Subject";
            url: string;
        }>

      Returns T

Optional destination

destination?: IDataDestination

Optional engine

engine?: ActorInitQueryBase<IQueryContextCommon>

Comunica query engine

Optional explain

explain?: QueryExplainMode

Optional extensionFunctionCreator

extensionFunctionCreator?: ((functionNamedNode) => ((args) => Promise<Term>))

Type declaration

    • (functionNamedNode): ((args) => Promise<Term>)

    • Parameters

      • functionNamedNode: NamedNode<string>

      Returns ((args) => Promise<Term>)

        • (args): Promise<Term>

        • Parameters

          • args: Term[]

          Returns Promise<Term>

Optional extensionFunctions

extensionFunctions?: Record<string, ((args) => Promise<Term>)>

Type declaration

    • (args): Promise<Term>

    • Parameters

      • args: Term[]

      Returns Promise<Term>

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: string | URL | Request
      • Optional init: RequestInit

      Returns Promise<Response>

Optional functionArgumentsCache

functionArgumentsCache?: FunctionArgumentsCache

Optional httpAuth

httpAuth?: `${string}:${string}`

Optional httpBodyTimeout

httpBodyTimeout?: boolean

Optional httpIncludeCredentials

httpIncludeCredentials?: boolean

Optional httpProxyHandler

httpProxyHandler?: IProxyHandler

Optional httpRetryCount

httpRetryCount?: number

Optional httpRetryDelay

httpRetryDelay?: number

Optional httpRetryOnServerError

httpRetryOnServerError?: boolean

Optional httpTimeout

httpTimeout?: number

Optional initialBindings

initialBindings?: Bindings

Optional lenient

lenient?: boolean

Optional log

log?: Logger

Optional queryFormat

queryFormat?: QueryFormat

The format in which the query string is defined. Defaults to { language: 'sparql', version: '1.1' }

Optional queryTimestamp

queryTimestamp?: Date

The date that should be used by SPARQL operations such as NOW().

Optional readOnly

readOnly?: boolean

Optional recoverBrokenLinks

recoverBrokenLinks?: boolean

Optional serialize

serialize?: ((obj, baseURI?) => Readonly<{
    predicates: Readonly<Record<string, Readonly<Partial<{
        blankNodes: readonly ((...) | (...))[];
        langStrings: Readonly<Record<(...), (...)>>;
        literals: Readonly<Record<(...), (...)>>;
        namedNodes: readonly string[];
    }>>>>;
    type: "Subject";
    url: string;
}>[])

Serialize the object to an RDF thing

Type declaration

    • (obj, baseURI?): Readonly<{
          predicates: Readonly<Record<string, Readonly<Partial<{
              blankNodes: readonly ((...) | (...))[];
              langStrings: Readonly<Record<(...), (...)>>;
              literals: Readonly<Record<(...), (...)>>;
              namedNodes: readonly string[];
          }>>>>;
          type: "Subject";
          url: string;
      }>[]

    • Parameters

      • obj: T
      • Optional baseURI: `http://${string}` | `https://${string}`

      Returns Readonly<{
          predicates: Readonly<Record<string, Readonly<Partial<{
              blankNodes: readonly ((...) | (...))[];
              langStrings: Readonly<Record<(...), (...)>>;
              literals: Readonly<Record<(...), (...)>>;
              namedNodes: readonly string[];
          }>>>>;
          type: "Subject";
          url: string;
      }>[]

Optional source

source?: IDataSource

sources

sources: [IDataSource, ...IDataSource[]]

An array of data sources the query engine must use.

Optional uid

uid?: string

Optional uriPrefix

uriPrefix?: string

URI prefix

Default

/openhps

Settings

Member Visibility

Theme

On This Page

baseIRIbaseUridatetimedeserializedestinationengineexplainextensionFunctionCreatorextensionFunctionsfetchfunctionArgumentsCachehttpAuthhttpBodyTimeouthttpIncludeCredentialshttpProxyHandlerhttpRetryCounthttpRetryDelayhttpRetryOnServerErrorhttpTimeoutinitialBindingslenientlogqueryFormatqueryTimestampreadOnlyrecoverBrokenLinksserializesourcesourcesuiduriPrefix