@0x4447/pretzel 中文文档教程

Question

Pretzel

在意识到没有 npm 模块可以递归验证具有多个嵌套值对象的 JSON 对象后，我们创建了 Pretzel 递归 JSON 数据验证。

我们知道 Validate.js，但正如作者所解释的，对完整对象的支持非常基础。 我们确实考虑过向该项目提出 PR，但事实证明源代码太难重新分区了。 因此，Pretzel 诞生了。

该工具的目标不仅仅是处理这样的嵌套 JSON

{
    "company_name": "0x4447",
    "address": {
        "street": "42 Life",
        "state": "TX",
        "code": 123456,
        "country": "United States",
        "contact": {
            "email": "hello@0x4447.email",
            "phone_nr": "+1 (555) 555-6666"
        }
    },
    "employs": {
        "ceo": {
            "individual": {
                "first_name": "David",
                "last_name": "Gatti"
            },
            "assistant": {
                "first_name": "Very",
                "last_name": "Helpful"
            }
        }
    }
}

......

{
    company_name: {
        type: 'string'
    },
    address: {
        street: {
            type: 'string'
        },
        state: {
            includes: ['AL', 'AK', 'AZ', 'AR', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'OH', 'OK', 'OR', 'PA', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VA', 'WA', 'WV', 'WI', 'WY']
        },
        code: {
            type: 'number'
        },
        country: {
            includes: ['United States', 'Canada']
        },
        contact: {
            email: {
                type: 'string'
            },
            phone_nr: {
                type: 'string'
            }
        }
    },
    employs: {
        ceo: {
            individual: {
                first_name: {
                    type: 'string'
                },
                last_name: {
                    type: 'string'
                }
            },
            assistant: {
                first_name: {
                    type: 'string'
                },
                last_name: {
                    type: 'string'
                }
            }
        }
    }
}

文件 如果您检查 index.js 文件，您就会明白我们的意思。 使用它，修改它，从中学习。

How to Install

] npm install @0x4447/pretzel

How to Test

] npm run test

How to Require

let pretzel = require('pretzel');

How to Use

let pretzel = require('pretzel');

//
//    RULES
//
let rules = {
    name: {
        type: "string"
    }
};

//
//    Good DATA
//
let good_data = {
    name: '0x4447'
};

//
//    Bad DATA
//
let bad_data = {
    name: 123321
};

//
//    1.  Execute validation.
//
let good = pretzel(good_data, rules);
let bad = pretzel(bad_data, rules);

//
//    2.  Check the validation result.
//
console.info(good);
console.info(bad);

Rules

以下是模块目前支持的所有规则的列表。

Bigger than

{
    biggerThan: 5
}

Smaller than

{
    smallerThan: 5
}

Comparison

{
    comparison: 1
}

Includes

{
    includes: [9, '0x4447']
}

Regular Expression

{
    regexp: '[aAzZ.-]'
}

Types

{
    type: "string || number || object || array"
}

The End

如果您喜欢这个项目，请考虑给它一个????。 并查看我们的 0x4447 GitHub 帐户，我们在其中提供您可能会觉得有用或有趣的其他资源。

Sponsor ????

该项目由 0x4447 LLC 提供，这是一家专门在 AWS 上构建自定义解决方案的软件公司。 通过以下链接了解更多信息：https://0x4447.com 或者说 hello@0x4447.email。