entity-port

    0.1.0 • Public • Published

    node-entity-port

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

    Table of Contents

    Synopsis

    An entity to manage network port including a prior validation of number during the instantiation.

    Usage

       const {PortEntity} = require('entity-port');
     
       # Create a new entity using invalid port number...
       let port1 = PortEntity.factory(-1024);
       # > ... throw an error.
     
       # Create a new entity using valid port number...
       let port1 = PortEntity.factory('443');
       # > ... and it's perfect ;-)
     

    Installation

    npm install entity-port
    

    API Reference

    Please refer to API documentation.

    Tests

    Run unit tests

    npm test
    

    Compatibility

    Node

    Tested using Node v9.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

    v0.1.0-alpha1 (2018-02-08)

    • Initial version.

    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.

    Install

    npm i entity-port

    DownloadsWeekly Downloads

    1

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    27.7 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar