Importing KeyLines

Getting Started

Introduction

Once you've installed KeyLines as a package, you can include it in your project just like other Javascript libraries. KeyLines supports the two main types of module loaders (ES6 modules and CommonJS/UMD modules) by including two separate bundles.

Import using ES6 imports

Import KeyLines using the 'keylines/esm' module specifier:

import KeyLines from 'keylines/esm';

Import using CommonJS/UMD

Require KeyLines using the 'keylines/umd' module specifier or its alias 'keylines':

const KeyLines = require('keylines');

For backwards compatibility and for use in script tags, this CommonJS/UMD module also sets a KeyLines global variable where ever its used. For example:

require('keylines');

// Access KeyLines via the global variable
KeyLines.create(...)

Terms of use

These terms do not alter or supersede any existing agreements between you (or your employer) and us.

By accessing or using any Content you agree to be bound by these Terms of Use. Please review these terms carefully before using the website.

The contents of this website, including but not limited to any text, code samples, API references, schemas, interactive tools, and other materials (collectively, the 'Content'), are made available for informational and internal evaluation purposes only. All intellectual property rights in the Content are reserved. No licence is granted to use the Content for any commercial purpose, or to copy, distribute, modify, reverse-engineer, or incorporate any part of the Content into any product or service, without our prior written consent.

This Content is provided “as is” and “as available,” without any representations, warranties, or guarantees of any kind, whether express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, non-infringement, or accuracy. To the fullest extent permitted by applicable law, we expressly exclude and disclaim all implied warranties, conditions, and other terms that might otherwise be implied.

We disclaim all liability for any loss or damage, whether direct, indirect, incidental, consequential, or otherwise, arising from any reliance placed on the Content or from your use of it, to the fullest extent permitted by applicable law. By continuing to access or use the Content, you acknowledge and agree to these terms.