Package Exports

imperial.js
imperial.js/lib/index.js
imperial.js/lib/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (imperial.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

imperial.js

Share code with anyone in a matter of seconds.

About

This is an official API wrapper for the IMPERIAL API. It's written in typescript and has premade type declarations.

Installation

Before using, make sure you have Node.js 8.0.0 or higher installed. Installation is done using these commands:

$ npm install imperial.js

or with yarn

$ yarn add imperial.js

Example Usage

import { Imperial } from "imperial.js";
// or
const Imperial = require("imperial.js").Imperial;

const client = new Imperial(/* token */);

client.createDocument("hello").then(console.log, console.error);

More can be found in the Imperial Documentation.

Running Locally

You can use these to run the tests:

$ npm ci
$ npm test

or with yarn

# if you already installed once make sure to remove node_modules
$ yarn install --frozen-lockfile
$ yarn test

Contributing

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work to your fork
Submit a Pull request so that I can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.