Context Template Repository (context-template)

A GitHub template repository for JSON-LD contexts.

Table of Contents

• Background
• Install
• Usage
• Developing
• Commercial Support
• License

Background

See also (related specs):

Install

Requires Node.js 12+

To install via NPM:

npm install context-template

Usage

import exampleCtx from 'context-template';
// or
const exampleCtx = require('context-template');
const {contexts, constants, appContextMap} = exampleCtx;

exampleCtx.CONTEXT_URL_V1
// 'https://w3id.org/example/v1'

// Codec term map value for CBOR-LD
exampleCtx.constants.CBORLD_CODEC_VALUE
// 0x0..

// get context data for a specific context
exampleCtx.CONTEXT_V1
// 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_V1 and CONTEXT_V1 (it's recommended that context repositories only export one context).
• constants: A Object that maps constants to well-known context URLs.
• contexts: A Map that maps URLs to full context data.
• appContextMap: For use with cborld 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.

License

• MIT license.