Neural Processing Mechanisms

    @mmit/check
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.19 • Public • Published

    Check

    Little helper that provides a syntax to type-safe check values for their validity.

    Installation

    npm i @mmit/check
    yarn add @mmit/check
    

    Why?

    export function isUsingDefaultPort(url: Url): boolean {
        // port can be undefined, WS complains about this
        const port: number = parseInt(url.port, 10);
        ...
        }
    
    // Looks much nicer!
    // parseInt get either a valid port or '' to parse        
    export function isUsingDefaultPort(url: Url): boolean {
        const port: number = parseInt(check(url.port).ifit(isANumber).else('80'), 10);
        ...
        }    

    Usage

    import { 
        check, 
        isBetween, 
        isLessThan, 
        isNotUndefined, 
        startsWith,
        isANumber } from '@mmit/check';
    
    const v1 = check(5).ifit(isNotUndefined).else(5);   // v1 = 5
    const v2 = check(3).ifit(isBetween(5, 10)).else(5); // v2 = 5
    const v3 = check(3).ifit(isBetween(3, 4)).else(5); //  v3 = 3
    const v4 = check(3).ifit(isLessThan(10)).else(10); //  v4 = 10
    const v5 = check('Test').ifit(startsWith('M')).else('<undefined>'); // v5 = '<undefined>'
    
    const url: Url = new URL('http://www.mikemitterer.at');
    const port = parseInt(check(url.port).ifit(isANumber).else('80'), 10 )

    It is quite easy to write your own Verifyer:

    import { Verifier } from '@mmit/check';
    
    export const endsWith: (test: string) => Verifier<string> = (test: string) => (value) => {
        return typeof value === 'string' && value.endsWith(test);
    };

    Check

    For more examples - pls check out my Tests

    Bugs / Contribute

    You reach me via GH - Issues

    Help is always welcome!

    Like

    If you like this package please star it here on GH or follow me on Twitter

    License

    MIT License
    
    Copyright (c) 2019, Mike Mitterer <office@mikemitterer.at>
    
    Mike Mitterer: http://www.MikeMitterer.at/
    
    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 @mmit/check

    DownloadsWeekly Downloads

    20

    Version

    0.2.19

    License

    MIT

    Unpacked Size

    1.31 MB

    Total Files

    50

    Last publish

    Collaborators

    • mmit