Skip to content

Latest commit

 

History

History
97 lines (67 loc) · 2.5 KB

README.md

File metadata and controls

97 lines (67 loc) · 2.5 KB
Raw

FIXME JSON-LD Context (@digitalbazaar/FIXME-context)

Build status NPM Version

A FIXME JSON-LD context for JavaScript.

Table of Contents

Background

See also (related specs):

Install

  • Requires Node.js 18+.

To install via NPM:

npm install @digitalbazaar/FIXME-context

Usage

// ESM
import * as ctx from '@digialbazaar/FIXME-context';
// CommonJS
const ctx = require('@digitalbazaar/FIXME-context');
const {contexts, constants, appContextMap} = ctx;

// Default context URL
ctx.CONTEXT_URL
// -> 'https://w3id.org/FIXME/v1'

// Default context data
ctx.CONTEXT
// -> full context object

// Default codec term map value for CBOR-LD
ctx.constants.CBORLD_VALUE
// ->  0x0..

This package can be used with bundlers, such as webpack, in browser applications.

API

The library exports the following properties:

  • CONTEXT_URL: Default context URL.
  • CONTEXT: Default context data.
  • CBORLD_VALUE: Default codec term map value for CBOR-LD.
  • constants: A Object that maps constants to well-known context URLs. The main constant CONTEXT_URL may be updated from time to time to the latest context location.
  • contexts: A Map that maps all context URLs to full context data.
  • appContextMap: For use with the cborld library.

Status

  • https://w3id.org/FIXME/v1: Under development. Not stable.

Developing

Source is available at:

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: [email protected]

License

  • BSD 3-Clause © Digital Bazaar
  • See the LICENSE file for details.