Interface SolidDataDriverOptions<T>

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

Properties

OptionalbaseIRI

baseIRI?: string

The baseIRI for parsing the query.

OptionalbaseUri

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

Optionaldatetime

datetime?: Date

Optionaldeserialize

deserialize?: ((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;
}>) => T)

Deserialize the RDF thing to instance

Optionaldestination

destination?: IDataDestination

Optionalengine

engine?: ActorInitQueryBase

Comunica query engine

Optionalexplain

explain?: QueryExplainMode

OptionalextensionFunctionCreator

extensionFunctionCreator?: ((functionNamedNode: NamedNode<string>) => ((args: Term[]) => Promise<Term>))

OptionalextensionFunctions

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

Optionalfetch

fetch?: {
    (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    (input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Type declaration

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

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

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

    • Parameters

      • input: string | URL | Request
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalfunctionArgumentsCache

functionArgumentsCache?: FunctionArgumentsCache

OptionalhttpAuth

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

OptionalhttpBodyTimeout

httpBodyTimeout?: boolean

OptionalhttpIncludeCredentials

httpIncludeCredentials?: boolean

OptionalhttpProxyHandler

httpProxyHandler?: IProxyHandler

OptionalhttpRetryCount

httpRetryCount?: number

OptionalhttpRetryDelay

httpRetryDelay?: number

OptionalhttpRetryOnServerError

httpRetryOnServerError?: boolean

OptionalhttpTimeout

httpTimeout?: number

OptionalinitialBindings

initialBindings?: Bindings

OptionalkeepChangelog

keepChangelog?: boolean

Keep a changelog of objects returned by the data service

Optionallenient

lenient?: boolean

Optionallog

log?: Logger

OptionalqueryFormat

queryFormat?: QueryFormat

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

OptionalqueryTimestamp

queryTimestamp?: Date

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

OptionalreadOnly

readOnly?: boolean

OptionalrecoverBrokenLinks

recoverBrokenLinks?: boolean

Optionalserialize

serialize?: ((obj: T, baseURI?: `http://${string}` | `https://${string}`) => 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

sources

sources: [QuerySourceUnidentified, ...QuerySourceUnidentified[]]

An array of data sources the query engine must use.

Optionaluid

uid?: string

OptionaluriPrefix

uriPrefix?: string

URI prefix

Default

/openhps

Settings

Member Visibility

On This Page

Properties