@dasch-swiss/dsp-js
Version:
JavaScript library that handles API requests to Knora
52 lines (51 loc) • 2.19 kB
TypeScript
import { ListNodeV2Cache } from "../../cache/ListNodeV2Cache";
import { OntologyCache } from "../../cache/ontology-cache/OntologyCache";
import { KnoraApiConfig } from "../../knora-api-config";
import { Endpoint } from "../endpoint";
import { AuthenticationEndpointV2 } from "./authentication/authentication-endpoint-v2";
import { ListsEndpointV2 } from "./list/lists-endpoint-v2";
import { OntologiesEndpointV2 } from "./ontology/ontologies-endpoint-v2";
import { ResourcesEndpointV2 } from "./resource/resources-endpoint-v2";
import { SearchEndpointV2 } from "./search/search-endpoint-v2";
import { ValuesEndpointV2 } from "./values/values-endpoint-v2";
/**
* Defines the V2 endpoint of the Knora API.
*
* @category Endpoint V2
*/
export declare class V2Endpoint extends Endpoint {
protected readonly knoraApiConfig: KnoraApiConfig;
protected readonly path: string;
private static readonly PATH_AUTHENTICATION;
private static readonly PATH_ONTOLOGIES;
private static readonly PATH_RESOURCES;
private static readonly PATH_VALUES;
private static readonly PATH_METADATA;
readonly auth: AuthenticationEndpointV2;
readonly onto: OntologiesEndpointV2;
readonly res: ResourcesEndpointV2;
readonly values: ValuesEndpointV2;
readonly list: ListsEndpointV2;
readonly search: SearchEndpointV2;
/**
* @deprecated This cache is kept for backwards compatibility with existing tests.
* Production code should NOT use this cache - endpoints create temporary caches per request.
* @category Internal
*/
readonly ontologyCache: OntologyCache;
/**
* @deprecated This cache is kept for backwards compatibility with existing tests.
* Production code should NOT use this cache - endpoints create temporary caches per request.
* @category Internal
*/
readonly listNodeCache: ListNodeV2Cache;
/**
* Sets up all endpoints for this endpoint.
*
* @param knoraApiConfig the configuration for the DSP-API instance to connect to.
* @param path this endpoint's path segment.
*
* @category Internal
*/
constructor(knoraApiConfig: KnoraApiConfig, path: string);
}