‚̧Namespace Pollution Mechanism
    Have ideas to improve npm?Join in the discussion! ¬Ľ

    @9fv.io/notimplemented-error

    1.0.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    node-notimplemented-error

    An exception class to throw 'not implemented' errors.


    ūüćé Warning ! Work in progress...

    JavaScript Style Guide Latest NPM release NPM Downloads TravisCI Build Status Test Coverage Code Climate License Dependencies Dev Dependencies Greenkeeper badge

    Table of Contents

    Synopsis

    An exception class to throw 'not implemented' errors.

    Usage

     
    const {NotImplementedError} = require('@9fv.io/notimplemented-error')
     
    function test() {
      throw new NotImplementedError('test() function is not implemented!') 
    }
     
    test()
    // throw an error of type {NotImplementedError}.
     

    Installation

    npm install @9fv.io/notimplemented-error
    

    API Reference

    Please refer to API documentation.

    Tests

    Run unit tests

    npm test
    

    Build

    Build documentation

    Be careful! Documentation (README and API) is generated using templates. Please only modify documentation from related templates.

    Then you can build documentation using the following command:

    npm run docs

    or:

    gulp docs

    Compatibility

    Node

    Tested using Node 9.5.0.

    Browser

    Untested at this time.

    Issues

    Feel free to submit issues and enhancement requests.

    Contributing

    Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

    1. Fork the repo on GitHub
    2. Clone the project to your own machine
    3. Commit changes to your own branch
    4. Push your work back up to your fork
    5. Submit a Pull request so that we can review your changes

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

    Credits

    History

    Please refer to the changelog file.

    License

    The MIT License

    Copyright (c) 2018 SAS 9 Février

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Keywords

    none

    Install

    npm i @9fv.io/notimplemented-error

    DownloadsWeekly Downloads

    2

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    25.2 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar