Skip to content

Brightspace/d2l-hypermedia-constants

Repository files navigation

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>

Versioning & Releasing

The incremental-release GitHub Action is called from the release.yml GitHub Action workflow to handle version changes and releasing.

When a PR is merged, a minor version bump will happen automatically, a release will be created, and the new version will be published 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.