15270821319 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
..
array 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
array-length 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
array-like 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
big-int 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
constructor 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
date 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
docs 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
error 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
finite 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
function 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
integer 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
iterable 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
lib 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
map 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
natural-number 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
number 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
object 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
plain-function 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
plain-object 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
promise 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
prototype 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
reg-exp 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
safe-integer 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
set 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
string 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
thenable 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
time-value 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
ts-types 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
value 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
CHANGELOG.md 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
LICENSE 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
README.md 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
ensure.js 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă
package.json 4e5c5d37f9 初步设计数据库,注册登录 6 luni în urmă

README.md

Build status Tests coverage npm version

type

Runtime validation and processing of JavaScript types

  • Respects language nature and acknowledges its quirks
  • Allows coercion in restricted forms (rejects clearly invalid input, normalizes permissible type deviations)
  • No transpilation implied, written to work in all ECMAScript 3+ engines

Use case

Validate arguments input in public API endpoints.

For validation of more sophisticated input structures (as deeply nested configuration objects) it's recommended to consider more powerful schema based utlities (as AJV or @hapi/joi)

Example usage

Bulletproof input arguments normalization and validation:

const ensureString        = require('type/string/ensure')
    , ensureDate          = require('type/date/ensure')
    , ensureNaturalNumber = require('type/natural-number/ensure')
    , isObject            = require('type/object/is');

module.exports = (path, options = { min: 0 }) {
  path = ensureString(path, { errorMessage: "%v is not a path" });
  if (!isObject(options)) options = {};
  const min = ensureNaturalNumber(options.min, { default: 0 })
      , max = ensureNaturalNumber(options.max, { isOptional: true })
      , startTime = ensureDate(options.startTime, { isOptional: true });

  // ...logic
};

Installation

npm install type

Utilities

Aside of general ensure validation util, following kind of utilities for recognized JavaScript types are provided:

*/coerce

Restricted coercion into primitive type. Returns coerced value or null if value is not coercible per rules.

*/is

Object type/kind confirmation, returns either true or false.

*/ensure

Value validation. Returns input value (in primitive cases possibly coerced) or if value doesn't meet the constraints throws TypeError .

Each */ensure utility, accepts following options (eventually passed with second argument):

  • isOptional - Makes null or undefined accepted as valid value. In such case instead of TypeError being thrown, null is returned.
  • default - A value to be returned if null or undefined is passed as an input value.
  • errorMessage - Custom error message. Following placeholders can be used:
    • %v - To be replaced with short string representation of invalid value
    • %n - To be replaced with meaninfgul name (to be passed with name option) of validated value. Not effective if name option is not present
  • errorCode - Eventual error code to be exposed on .code error property
  • name - Meaningful name for validated value, to be used in error message, assuming it contains %n placeholder
  • Error - Alternative error constructor to be used (defaults to TypeError)

Index

General utils:

Type specific utils:

Tests

$ npm test

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.