runtime-type v4.1.1

runtime-type

Module for casting to types at runtime.

Installation

npm install --save runtime-type

Usage

import Type from 'runtime-type';

Type.integer.cast('5'); // returns 5
Type.integer.cast('test'); // throws an Error

Type.integer.canCast('5'); // returns true
Type.integer.isValidType('5'); // returns false
Type.integer.isValid('5'); // returns false

Functions

Every type has several methods.

cast(value)

Casts the value to the type. It returns value in the desired type or throws an Error.

saveCast(value, defaultValue)

Tries to cast the value. If the cast fails the defaultValue is returned.

canCast(value)

Checks if the value is valid. It calls the cast method and if the cast is successful true is returned. If the cast throw an error false is returned.

isValidType(value)

Chekcs the value using typeof defined in the inherited type.

isValid(value)

Checks if the value is strictly valid. Calls canCast(value) and isValidType(value).

Types

enum_

The enum_ function is alias to enum because of typescript.

Migrating to v3

The isValid method now validates the value strictly as mentioned above. The easiest way to migrate is just to rename all references to canCast. Everything else remains the same.

// v2
Type.integer.isValid('5'); // returns true
// v3
Type.integer.isValid('5'); // returns false
Type.integer.canCast('5'); // returns true