0.0.0 • Published 4 years ago

jsonld-cached v0.0.0

Weekly downloads
-
License
ISC
Repository
gitlab
Last release
4 years ago

JsonLd Cached

Create an instance of JsonLd with a context cache and custom fetch.

import JsonLdCached from 'jsonld-cached';
import fetch from 'node-fetch';
import activityStreams from './contexts/activitystreams.js';

const contexts = {
	'https://www.w3.org/ns/activitystreams': activitystreams
}

const jsonld = JsonLdCached({ contexts, fetch });

Dependencies

  • jsonld: ^5.2.0

Modules

Typedefs

External

jsonld-cached

Jsonld Cached

jsonld-cached.JsonLdFetchError

An error that occured while fetching a JSONLD resource

Kind: static class of jsonld-cached
Properties

NameTypeDescription
responseFetch.ResponseThe fetch response object

jsonld-cached~default ⇒ JsonLd

Create an instance of the JsonLD library, with a context cache and custom fetch

Kind: inner property of jsonld-cached
Returns: JsonLd - An instance of JSONLD
Throws:

  • JsonLdFetchError The http request for a resource did not respond with a 2xx status code
ParamTypeDescription
optionsObjectOptions object
options.contextsContextCacheA dict or map-like data structure for caching contexts
options.fetchFetchA fetch-like method for making http requests

Fetch : function

An method adhering to the fetch spec

Kind: global typedef

ContextCache : Object | Map | Maplike

An object or map-like for caching contexts

Kind: global typedef

Maplike : Object

An object with set and get functions

Kind: global typedef

ParamTypeDescription
get.keystringThe url to get for
set.keystringThe url to set for
set.valuestringThe value to set

Properties

NameTypeDescription
getfunctionGet a value from the cache - can be async
setfunctionSet a value in the cache - can be async

JsonLd

The jsonld package

Kind: global external
See: jsonld

0.0.0

4 years ago