@octra/assets

This library contains assets like JSON schema definitions.

Installation

ESM, CJS, TS definitions & UMD (optional)

npm install --save @octra/assets
Copy

UMD Bundle (for Vanilla JS)

You have two options to install this package und use it as UMD:

a) Install via NPM and reference local files (no internet connection needed om production).

<script type="application/javascript" src="node_modules/@octra/assets/index.umd.js"></script>
Copy

b) Reference remote file (internet connection needed on production).

<script type="application/javascript" src="https://unpkg.com/@octra/assets/index.umd.js"></script>
Copy

See full example here

Use

Import

ESM, Typescript

Import the classes and functions from @octra/assets. For example

import { OctraGuidelinesJSONSchema } from '@octra/assets';
Copy

UMD Bundle

All functions and classes are available via global scope OctraAssets. For example:

/*
make sure that you have injected the umd bundle as described before.
 */
const guidelinesJSONSchema = OctraAssets.OctraGuidelinesJSONSchema;
Copy

API

You can find more information about classes and functions of @octra/assets here.