Deviator

TypeScript value transformation and validation library that leverages the type system to provide correct types during deviation creation and for deviation results.

Installation

$3

``
$ npm install deviator
`

$3

`
$ yarn add deviator
`

Examples

$3

`typescript
import { deviate } from "deviator";

const toInteger = deviate()
.trim()
.nonempty()
.replace(",", ".")
.toNumber()
.round(0);

console.log(toInteger(" Hello ")); // { ok: false, continue: false, value: 'toNumber' }
console.log(toInteger(" 12,5 ")); // { ok: true, continue: true, value: 13 }
`

$3

`typescript
import { deviate } from "deviator";

interface Credentials {
email: string;
password: string;
}

const validate = deviate().shape({
email: deviate().trim().lowercase().email(),
password: deviate().nonempty()
});

console.log(validate({ email: "raw input", password: "" }));
// { ok: false, continue: false, value: { email: 'email', password: 'nonempty' } }

console.log(validate({ email: " Hello@There.com ", password: "secret" }));
// { ok: true, continue: true, value: { email: 'hello@there.com', password: 'secret' } }
`

$3

`typescript
import { deviate } from "deviator";

const validate = deviate().object().shape({
id: deviate().string().guid(),
amount: deviate().number().round(2)
});

console.log(validate("A random string"));
// { ok: false, continue: false, value: 'object' }

console.log(validate({ id: undefined, amount: 12 }));
// { ok: false, continue: false, value: { id: 'string' } }

console.log(validate({ id: "80ceadad-f9ab-44b4-b11e-940cc1cd85aa", amount: 20 }));
// { ok: true, continue: true, value: { id: '80ceadad-f9ab-44b4-b11e-940cc1cd85aa', amount: 20 } }
`

$3

`typescript
import { deviate, ok } from "deviator";

const squareAndReverse = deviate()
.then(input => ok(input * input))
.then(input => ok(input.toString()))
.then(input => ok(input.split("").reverse().join("")));

console.log(squareAndReverse(10)); // { ok: true, continue: true, value: '001' }
``