@altostra/type-validations
Utility functions to create type-guards and assertions.
Last updated 4 months ago by altostra-npm .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @altostra/type-validations 
SYNC missed versions from official npm registry.

Type validations

CI npm version

Type validations is a library for creating type-validators: augmented type-guards that perform full runtime type-validation and let TypeScript type checker know what a type may be in a certain context.

Installation

$ npm install @altostra/type-validations

Reference

A full reference can be found here.

allOf

Creates type-validators for an intersections-type from a list of type-validators.

anyOf

Creates type-validators for a union-type from a list of type-validators.

arrayOf

Given type-guard for type T, creates a type-validator for T[].

assertBy

Create assertion-functions from type-validation and an error-factory.

enumOf

Creates a type-validation that checks if a value is one of the specified values (using strict equality).

is

Creates a type-validation that only allows values that are strictly equal to the provided value.

isEmptyArray

A type-validation that checks if a value is an empty array.

isEmptyObject

A type-validation that checks if a value is an empty object.

isFunction

Creates a type-validation that checks if a value is a function with a specified length.

maybe

Creates a type-validation that checks if a value is of validated type, undefined, and optionally null.

objectOf

Creates type-validation that checks if a value is an object that all its properties are validated with the provided validations.

recordOf

Creates type-validator that checks that a given value is an object and that all its properties are of a specific type.

singleOrArray

Creates a type-validation that checks if a value is either a specific type or an array of that type.

tupleOf

Creates a type-validation that checks that an object is an array with a specific length, and has all the provided indices validated.

Primitives

Type-validations

  • string
  • maybeString
  • number
  • maybeNumber
  • boolean
  • maybeBoolean
  • nullValidation
  • nullOrUndefined
  • undefinedValidation
  • symbol
  • maybeSymbol
  • bigint
  • maybeBigint
  • any
  • unknown
  • never

Type-assertions

  • stringAssertion
  • maybeStringAssertion
  • numberAssertion
  • maybeNumberAssertion
  • booleanAssertion
  • maybeBooleanAssertion
  • nullAssertion
  • nullOrUndefinedAssertion
  • undefinedAssertion
  • symbolAssertion
  • maybeSymbolAssertion
  • bigintAssertion
  • maybeBigintAssertion
  • anyAssertion
  • unknownAssertion
  • assert

Current Tags

  • 1.0.2                                ...           latest (4 months ago)
  • 2.0.0-ts-41.0                                ...           ts41 (5 days ago)

3 Versions

  • 2.0.0-ts-41.0                                ...           5 days ago
  • 1.0.2                                ...           4 months ago
  • 1.0.1                                ...           6 months ago
Maintainers (1)
Downloads
Today 0
This Week 4
This Month 13
Last Day 0
Last Week 7
Last Month 4
Dependencies (1)
Dev Dependencies (12)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |