d2l-hypermedia-constants

Library of constants for communicating with D2L's Hypermedia APIs

Usage no npm install needed!

<script type="module">
  import d2lHypermediaConstants from 'https://cdn.skypack.dev/d2l-hypermedia-constants';
</script>

README

d2l-hypermedia-constants

Library of constants useful when using hypermedia.

Installation

d2l-hypermedia-constants can be installed from NPM:

npm install --save d2l-hypermedia-constants

Usage

Node.js

const hypermediaConstants = require('d2l-hypermedia-constants');
console.log(hypermediaConstants.Actions);
console.log(hypermediaConstants.Classes);
console.log(hypermediaConstants.Rels);

ES6 Module Import

import {Actions, Classes, Rels} from 'd2l-hypermedia-constants';
console.log(Actions);
console.log(Classes);
console.log(Rels);

ES6 Module Global

<script type="module" src="../d2l-hypermedia-constants/d2l-hypermedia-constants.js"></script>
<script>
console.log(D2L.Hypermedia.Actions);
console.log(D2L.Hypermedia.Classes);
console.log(D2L.Hypermedia.Rels);
</script>

Releases

To generate a new release:

npm version [major|minor|patch] -m "New version: %s"
git push origin master --tags

This will update the version in the package.json file, commit that, and generate a new tag.

When Travis CI runs on the tagged release, it will be deployed to NPM.

Coding styles

See the Best Practices & Style Guide for information on naming conventions, plus information about the EditorConfig rules used in this repo.