@plumier/validator
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.6 • Public • Published

    TypedConverter

    Convert object into classes match with TypeScript type annotation

    Build Status Coverage Status Greenkeeper badge

    Performance

    TypedConverter uses several performance optimization, first it traverse Type properties using efficient properties traversal then compiles TypeScript types into optimized object graph contains functions for conversion.

    Performance compared to Joi

    Test Type                          Sec
    Joi - Type conversion            17.62
    Joi - Validation                 61.67
    TypedConverter - Type conversion  7.29
    TypedConverter - Validation      23.51
    

    To run benchmark:

    • Clone this repo
    • yarn install
    • yarn benchmark

    Usage

    import reflect from "@plumier/reflect"
    import { createValidator, val } from "@plumier/validator"
    
    @reflect.parameterProperties()
    class User {
        constructor(
            @val.email()
            public email:string,
            public name:string,
            @val.before()
            public dateOfBirth:Date,
            public isActive:boolean
        ){}
    }
    
    // create validation function
    const validate = createValidator(User)
    // this configuration will result the same
    // const validate = createValidator({ type: User })
    // validate raw value
    const user = validate({ 
        email: "john.doe@gmail.com", name: "John Doe", 
        dateOfBirth: "1991-1-2", isActive: "true" 
    })
    
    // create validation function for array
    const validate = createValidator([User])
    // validate raw value
    const user = validate([{ 
        email: "john.doe@gmail.com", name: "John Doe", 
        dateOfBirth: "1991-1-2", isActive: "true" 
    }, { 
        email: "jane.deane@gmail.com", name: "Jane Deane", 
        dateOfBirth: "1994-1-2", isActive: "false" 
    },
    ])
    

    Without Factory

    createValidator good to have a shared validator configuration, but for single usage its better to use the validate function.

    import reflect from "@plumier/reflect"
    import { validate, val } from "@plumier/validator"
    
    @reflect.parameterProperties()
    class User {
        constructor(
            @val.email()
            public email:string,
            public name:string,
            @val.before()
            public dateOfBirth:Date,
            public isActive:boolean
        ){}
    }
    
    // pass the Type as the second parameter
    const user = validate({ 
        email: "john.doe@gmail.com", name: "John Doe", 
        dateOfBirth: "1991-1-2", isActive: "true" 
    }, User)
    // can be passed as option too
    // const user = validate(<raw value>, { type: User })

    Guess Array Element

    Useful when converting data from url encoded, where single value could be a single array.

    const b = await convert("1", { type: [Number], guessArrayElement: true }) // -> result = [1]

    Note that, when the type passed to the configuration is of type Array, providing single value will guessed as Array.

    Extending with Visitors

    Visitors executed after conversion process traverse through properties / array element. Invocation can be multiple and run in sequence the last sequence will execute the converter. Visitors work like Plumier middleware

    Signature of Visitor is like below:

    type Visitor = (invocation: VisitorInvocation) => VisitorResult

    Visitor is a function receive two parameters value and invocation.

    • invocation next invocation

    Example:

    import { createValidation, Result, VisitorInvocation } from "@plumier/validator"
    
    const olderThanEightTeen = (i: VisitorInvocation) => {
        if (i.type === Number && i.value < 18)
            return Result.error(i.path, "Must be older than 18")
        else
            return i.proceed()
    }
    
    const validate = createValidation({ type: Number, visitors: [olderThanEightTeen] })
    const result = validate("40") // { value: 40 }
    const other = validate("12") // { issues: [{path: "", messages: ["Must be older than 18"]}]  }

    Install

    npm i @plumier/validator

    DownloadsWeekly Downloads

    8

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    54.4 kB

    Total Files

    20

    Last publish

    Collaborators

    • ktutnik