Have ideas to improve npm?Join in the discussion! »

    r2-lcp-js

    1.0.30 • Public • Published

    NodeJS / TypeScript Readium-2 "LCP" components

    NodeJS implementation (written in TypeScript) of LCP modules for the Readium2 architecture ( https://github.com/readium/architecture/ ).

    License

    Build status

    NPM David

    Changelog

    Prerequisites

    1. https://nodejs.org NodeJS >= 8, NPM >= 5 (check with command line node --version and npm --version)
    2. 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):

    1. cd r2-lcp-js
    2. git status (please ensure there are no local changes, especially in package-lock.json and the dependency versions in package.json)
    3. rm -rf node_modules (to start from a clean slate)
    4. npm install, or alternatively npm ci (both commands initialize the node_modules tree of package dependencies, based on the strict package-lock.json definition)
    5. npm run build:all (invoke the main build script: clean, lint, compile)
    6. ls dist (that's the build output which gets published as NPM package)

    Documentation

    TODO

    Install

    npm i r2-lcp-js

    DownloadsWeekly Downloads

    257

    Version

    1.0.30

    License

    BSD-3-Clause

    Unpacked Size

    1.18 MB

    Total Files

    282

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar