itcast 6e512b8ce6 aaaa 5 maanden geleden
..
array 6e512b8ce6 aaaa 5 maanden geleden
array-length 6e512b8ce6 aaaa 5 maanden geleden
array-like 6e512b8ce6 aaaa 5 maanden geleden
big-int 6e512b8ce6 aaaa 5 maanden geleden
constructor 6e512b8ce6 aaaa 5 maanden geleden
date 6e512b8ce6 aaaa 5 maanden geleden
docs 6e512b8ce6 aaaa 5 maanden geleden
error 6e512b8ce6 aaaa 5 maanden geleden
finite 6e512b8ce6 aaaa 5 maanden geleden
function 6e512b8ce6 aaaa 5 maanden geleden
integer 6e512b8ce6 aaaa 5 maanden geleden
iterable 6e512b8ce6 aaaa 5 maanden geleden
lib 6e512b8ce6 aaaa 5 maanden geleden
map 6e512b8ce6 aaaa 5 maanden geleden
natural-number 6e512b8ce6 aaaa 5 maanden geleden
number 6e512b8ce6 aaaa 5 maanden geleden
object 6e512b8ce6 aaaa 5 maanden geleden
plain-function 6e512b8ce6 aaaa 5 maanden geleden
plain-object 6e512b8ce6 aaaa 5 maanden geleden
promise 6e512b8ce6 aaaa 5 maanden geleden
prototype 6e512b8ce6 aaaa 5 maanden geleden
reg-exp 6e512b8ce6 aaaa 5 maanden geleden
safe-integer 6e512b8ce6 aaaa 5 maanden geleden
set 6e512b8ce6 aaaa 5 maanden geleden
string 6e512b8ce6 aaaa 5 maanden geleden
thenable 6e512b8ce6 aaaa 5 maanden geleden
time-value 6e512b8ce6 aaaa 5 maanden geleden
ts-types 6e512b8ce6 aaaa 5 maanden geleden
value 6e512b8ce6 aaaa 5 maanden geleden
CHANGELOG.md 6e512b8ce6 aaaa 5 maanden geleden
LICENSE 6e512b8ce6 aaaa 5 maanden geleden
README.md 6e512b8ce6 aaaa 5 maanden geleden
ensure.js 6e512b8ce6 aaaa 5 maanden geleden
package.json 6e512b8ce6 aaaa 5 maanden geleden

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.