类型检查

type-check 是一个库，它允许你在运行时用类似Haskell的类型语法检查JavaScript值的类型。它非常适合检查外部输入、测试，甚至可以为内部代码添加一点安全性。它是…的主要组成部分 levn． 麻省理工学院的许可。0.4.0版本。请查看 演示。

有关 type-check， 在twitter上关注我。

npm install type-check

快速的例子

// Basic types:
var typeCheck = require('type-check').typeCheck;
typeCheck('Number', 1);               // true
typeCheck('Number', 'str');           // false
typeCheck('Error', new Error);        // true
typeCheck('Undefined', undefined);    // true

// Comment
typeCheck('count::Number', 1);        // true

// One type OR another type:
typeCheck('Number | String', 2);      // true
typeCheck('Number | String', 'str');  // true

// Wildcard, matches all types:
typeCheck('*', 2) // true

// Array, all elements of a single type:
typeCheck('[Number]', [1, 2, 3]);                // true
typeCheck('[Number]', [1, 'str', 3]);            // false

// Tuples, or fixed length arrays with elements of different types:
typeCheck('(String, Number)', ['str', 2]);       // true
typeCheck('(String, Number)', ['str']);          // false
typeCheck('(String, Number)', ['str', 2, 5]);    // false

// Object properties:
typeCheck('{x: Number, y: Boolean}', {x: 2, y: false});             // true
typeCheck('{x: Number, y: Boolean}',       {x: 2});                 // false
typeCheck('{x: Number, y: Maybe Boolean}', {x: 2});                 // true
typeCheck('{x: Number, y: Boolean}',      {x: 2, y: false, z: 3});  // false
typeCheck('{x: Number, y: Boolean, ...}', {x: 2, y: false, z: 3});  // true

// A particular type AND object properties:
typeCheck('RegExp{source: String, ...}', /re/i);          // true
typeCheck('RegExp{source: String, ...}', {source: 're'}); // false

// Custom types:
var opt = {customTypes:
  {Even: { typeOf: 'Number', validate: function(x) { return x % 2 === 0; }}}};
typeCheck('Even', 2, opt); // true

// Nested:
var type = '{a: (String, [Number], {y: Array, ...}), b: Error{message: String, ...}}'
typeCheck(type, {a: ['hi', [1, 2, 3], {y: [1, 'ms']}], b: new Error('oh no')}); // true

请查看 类型语法格式 和 指南。

用法

require('type-check'); 返回一个公开四个属性的对象。 VERSION 以字符串形式表示库的当前版本。 typeCheck， parseType, parsedTypeCheck 是功能。

// typeCheck(type, input, options);
typeCheck('Number', 2);               // true

// parseType(type);
var parsedType = parseType('Number'); // object

// parsedTypeCheck(parsedType, input, options);
parsedTypeCheck(parsedType, 2);       // true

typeCheck（类型，输入，选项）

typeCheck 检查JavaScript值 input 反对 type 写在 类型格式 (并考虑到可选的 options)并返回 input 匹配 type。

参数

• 类型, String -写在 类型格式 要对照哪一个
• 输入- * -任何JavaScript值，将根据类型进行检查
• 选项- Maybe Object -一个可选参数，指定附加选项，目前唯一可用的选项是指定 自定义类型

返回

Boolean -输入是否与类型匹配

例子

typeCheck('Number', 2); // true

parseType(类型)

parseType 解析字符串 type 写在 类型格式 转换为表示已解析类型的对象。

参数

• 类型, String -写在 类型格式 要解析哪个

返回

Object -以解析类型格式表示解析类型的对象

例子

parseType('Number'); // [{type: 'Number'}]

parsedTypeCheck（parsedType, input, options）

parsedTypeCheck 检查JavaScript值 input 对解析 type 在已解析的类型格式中(并考虑可选的 options)并返回 input 匹配 type． 与…结合使用 parseType 如果要多次使用一个类型。

参数

• 类型, Object -要检查的已解析类型格式中的类型
• 输入- * -任何JavaScript值，将根据类型进行检查
• 选项- Maybe Object -一个可选参数，指定附加选项，目前唯一可用的选项是指定 自定义类型

返回

Boolean -输入是否与类型匹配

例子

parsedTypeCheck([{type: 'Number'}], 2); // true
var parsedType = parseType('String');
parsedTypeCheck(parsedType, 'str');     // true

{}.toString.call(VALUE).slice(8, -1)
{}.toString.call(true).slice(8, -1) // 'Boolean'

请查看 类型优先级 用于类型检查的库。

选项

Options是一个对象。的可选参数 typeCheck 和 parsedTypeCheck 功能。当前唯一的选择是 customTypes。

var options = {
  customTypes: {
    Even: {
      typeOf: 'Number',
      validate: function(x) {
        return x % 2 === 0;
      }
    }
  }
};
typeCheck('Even', 2, options); // true
typeCheck('Even', 3, options); // false

type-check 写在 LiveScript -一种编译成JavaScript的语言。它还使用 prelude.ls 图书馆。