layer2storage
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.18 • Public • Published

    Layer2 storage proxy, TypeScript library

    NPM scripts

    • npm t: Run test suite
    • npm start: Run npm run build in watch mode
    • npm run test:watch: Run test suite in interactive watch mode
    • npm run test:prod: Run linting and generate coverage
    • npm run build: Generate bundles and typings, create docs
    • npm run lint: Lints code
    • npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

    Excluding peerDependencies

    On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.

    Good news: the setup is here for you, you must only include the dependency name in external property within rollup.config.js. For example, if you want to exclude lodash, just write there external: ['lodash'].

    Automatic releases

    Prerequisites: you need to create/login accounts and add your project to:

    Prerequisite for Windows: Semantic-release uses node-gyp so you will need to install Microsoft's windows-build-tools using this command:

    npm install --global --production windows-build-tools

    Git Hooks

    There is already set a precommit hook for formatting your code with Prettier 💅

    By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

    This makes more sense in combination with automatic releases

    FAQ

    Array.prototype.from, Promise, Map... is undefined?

    TypeScript or Babel only provides down-emits on syntactical features (class, let, async/await...), but not on functional features (Array.prototype.find, Set, Promise...), . For that, you need Polyfills, such as core-js or babel-polyfill (which extends core-js).

    For a library, core-js plays very nicely, since you can import just the polyfills you need:

    import "core-js/fn/array/find"
    import "core-js/fn/string/includes"
    import "core-js/fn/promise"
    ...

    Keywords

    none

    Install

    npm i layer2storage

    DownloadsWeekly Downloads

    2

    Version

    0.0.18

    License

    MIT

    Unpacked Size

    183 kB

    Total Files

    10

    Last publish

    Collaborators

    • alexvlewis
    • billie-badger
    • jadbox
    • jamesyoung
    • nginnever