r2-lcp-js
v1.0.41
Published
Readium 2 LCP bits for NodeJS (TypeScript)
Downloads
6,640
Readme
NodeJS / TypeScript Readium-2 "LCP" components
NodeJS implementation (written in TypeScript) of LCP modules for the Readium2 architecture ( https://github.com/readium/architecture/ ).
Build status
Prerequisites
- https://nodejs.org NodeJS >= 8, NPM >= 5 (check with command line
node --version
andnpm --version
) - OPTIONAL: https://yarnpkg.com Yarn >= 1.0 (check with command line
yarn --version
)
GitHub repository
https://github.com/readium/r2-lcp-js
There is no github.io site for this project (no gh-pages branch).
NPM package
https://www.npmjs.com/package/r2-lcp-js
Command line install:
npm install r2-lcp-js
OR
yarn add r2-lcp-js
...or manually add in your package.json
:
"dependencies": {
"r2-lcp-js": "latest"
}
The JavaScript code distributed in the NPM package is usable as-is (no transpilation required), as it is automatically-generated from the TypeScript source.
Several ECMAScript flavours are provided out-of-the-box: ES5, ES6-2015, ES7-2016, ES8-2017:
https://unpkg.com/r2-lcp-js/dist/
(alternatively, GitHub mirror with semantic-versioning release tags: https://github.com/edrlab/r2-lcp-js-dist/tree/develop/dist/ )
The JavaScript code is not bundled, and it uses require()
statement for imports (NodeJS style).
More information about NodeJS compatibility:
http://node.green
Note that web-browser Javascript is currently not supported (only NodeJS runtimes).
The type definitions (aka "typings") are included as *.d.ts
files in ./node_modules/r2-lcp-js/dist/**
, so this package can be used directly in a TypeScript project.
Example usage:
// currently no index file
// import { * } from "r2-lcp-js";
// ES5 import (assuming node_modules/r2-lcp-js/):
import { downloadEPUBFromLCPL } from "r2-lcp-js/dist/es5/src/publication-download";
// ... or alternatively using a convenient path alias in the TypeScript config (+ WebPack etc.):
import { downloadEPUBFromLCPL } from "@r2-lcp-js/publication-download";
Dependencies
https://david-dm.org/readium/r2-lcp-js
A package-lock.json is provided (modern NPM replacement for npm-shrinkwrap.json
).
A yarn.lock file is currently not provided at the root of the source tree.
Continuous Integration
TODO (unit tests?) https://travis-ci.org/readium/r2-lcp-js
Badge: [![Travis](https://travis-ci.org/readium/r2-lcp-js.svg?branch=develop)](https://travis-ci.org/readium/r2-lcp-js)
Version(s), Git revision(s)
NPM package (latest published):
https://unpkg.com/r2-lcp-js/dist/gitrev.json
Alternatively, GitHub mirror with semantic-versioning release tags:
https://raw.githack.com/edrlab/r2-lcp-js-dist/develop/dist/gitrev.json
Developer quick start
Command line steps (NPM, but similar with YARN):
cd r2-lcp-js
git status
(please ensure there are no local changes, especially inpackage-lock.json
and the dependency versions inpackage.json
)rm -rf node_modules
(to start from a clean slate)npm install
, or alternativelynpm ci
(both commands initialize thenode_modules
tree of package dependencies, based on the strictpackage-lock.json
definition)npm run build:all
(invoke the main build script: clean, lint, compile)ls dist
(that's the build output which gets published as NPM package)
Documentation
TODO