Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

type

Package Overview
Dependencies
0
Maintainers
2
Versions
20
Issues
File Explorer

Advanced tools

type

Runtime validation and processing of JavaScript types

    2.7.2latest

Version published
Maintainers
2
Weekly downloads
19,605,425
increased by4.57%

Weekly downloads

Changelog

Source

2.7.2 (2022-08-05)

Maintenance Improvements

  • TS: Improve ensure options handling (#8) (4a54066) (Marco)

Readme

Source

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

Keywords

FAQs

What is type?

Runtime validation and processing of JavaScript types

Is type popular?

The npm package type receives a total of 16,498,766 weekly downloads. As such, type popularity was classified as popular.

Is type well maintained?

We found that type demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 2 open source maintainers collaborating on the project.

Last updated on 05 Aug 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc