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

    0.2.0 • Public • Published

    forma Build Status

    WIP

    TODO

    Install

    $ npm install --save forma
    

    Usage

    // TODO

    Rule Definitions

    TODO

    Schemas

    TODO

    API

    rule(block, toString)

    Returns: Function or String

    Generates a function to validate a single value/field.

    Important: Do not use this to validate Arrays or Objects!

    block

    Type: Object

    The rule's block definition – see Rule Definitions for more.

    toString

    Type: Boolean
    Default: false

    validate(schema, data)

    Returns: Object or false

    Instantly validate the data against a ruleset.

    Note: Meant for singleton/one-off validations!
    Use forma.compile() if you plan to reuse the same schema multiple times.

    schema

    Type: Object

    The set of rule definitions for your incoming data object – see Schemas for more.

    data

    Type: Object

    The value object to be validated.

    compile(schema)

    Returns: Function

    Generates an optimized function that can be reused to validate incoming data.

    Note: Ideal for repeat validations – huge performance boost!
    Use forma.validate() if you only plan to validate once.

    schema

    Type: Object

    The set of rule definitions for your incoming data object – see Schemas for more.

    Benchmarks

    TODO

    License

    MIT © Luke Edwards

    Keywords

    none

    Install

    npm i forma

    DownloadsWeekly Downloads

    3

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    10.1 kB

    Total Files

    7

    Last publish

    Collaborators

    • lukeed