2.0.1 • Published 11 months ago
@digitalbazaar/multikey-context v2.0.1
Multikey Context for JavaScript (@digitalbazaar/multikey-context)
A Multikey context library for JavaScript.
Table of Contents
Background
See also (related specs):
Install
Requires Node.js 16+
To install via NPM:
npm install @digitalbazaar/multikey-context
Usage
import multikeyContext from '@digitalbazaar/multikey-context';
multikeyContext.CONTEXT_URL
// 'https://w3id.org/security/multikey/v1'
// Codec term map value for CBOR-LD
multikeyContext.constants.CBORLD_CODEC_VALUE
// 0x31
// get context data for a specific context
multikeyContext.CONTEXT
// full context object
This package can be used with bundlers, such as webpack, in browser applications.
API
The library exports the following properties:
CONTEXT_URL
CONTEXT
constants
: A Object that maps constants to well-known context URLs. The main constantCONTEXT_URL
may be updated from time to time to the latest context location.contexts
: AMap
that maps URLs to full context data.appContextMap
: For use withcborld
library.
Developing
WARNING: The .jsonld
in contexts/
is auto-generated by the npm run build
script,
each time you run the test suite.
DO NOT edit it directly (or your changes will be quickly overwritten).
Instead, make all context changes to js/context.js
.
Commercial Support
Commercial support for this library is available upon request from Digital Bazaar: support@digitalbazaar.com
License
- BSD 3-Clause © Digital Bazaar
- See the LICENSE file for details.