Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SfsApiConfig

Interface representing SfsApi configuration. Extends {@link ISparqlEndpointFetcherArgs} which are passed to {@link SparqlEndpointFetcher}.

Hierarchy

  • ISparqlEndpointFetcherArgs
    • SfsApiConfig

Index

Properties

Methods

Properties

Optional additionalUrlParams

additionalUrlParams?: URLSearchParams

baseQuery

baseQuery: string

SPARQL SELECT query used for fetching results. Will be enriched with active facet patterns.

IMPORTANT: baseQuery has to return _id and _label variable.

  • _id variable is used as primary row identifier and other facets use this variable to build their own queries.
  • _label variable is used when using search query.
  • All SPARQL variables used by sfs-api are prefixed with "_" so you should not name your other variables like this.

Optional dataFactory

dataFactory?: DataFactory<Quad, Quad>

A custom datafactory.

endpointUrl

endpointUrl: string

URL of SPARQL endpoint.

facets

facets: Facet<unknown>[]

Facets used in this SfsApi.

language

language: string

Language used for facet labels.

Optional method

method?: "POST" | "GET"

A custom HTTP method for issuing (non-update) queries, defaults to POST. Update queries are always issued via POST.

Optional prefixVariableQuestionMark

prefixVariableQuestionMark?: boolean

If variable names should be prefixed with a quotation mark.

Optional prefixes

prefixes?: Prefixes

Prefixes used in results or facet queries.

remarks

Use record-like object e.g. { rdfs: "http://www.w3.org/2000/01/rdf-schema#", skos: "http://www.w3.org/2004/02/skos/core#", owl: "https://www.w3.org/2002/07/owl#", dct: "http://purl.org/dc/terms/" }

Methods

Optional fetch

  • fetch(input?: string | Request, init?: RequestInit): Promise<Response>

  • A custom fetch function.

    Parameters

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

    Returns Promise<Response>

Generated using TypeDoc