node-adjuster

validate and adjust input values

Introduction
Install
Loading
Reference
- types and constants
- basic usage
- boolean
- number
- string
- numeric string
- email
- array
- object
Changelog

Introduction

All of web applications need handling input parameters, consists of following steps:

existence check
- all required parameters exist?
- fill omittable parameters by default values
type check
- e.g., typeof age === "number"
- cast them if needed; "20"(string) to 20(number)
domain check
- e.g., 1 <= limit && limit <= 100
- revise them if needed; 0 to 1

node-adjuster does all of them, by compact and highly readable code!

example

import adjuster from "adjuster";
import assert from "assert";

const constraints = { // constraints for input
    id: adjuster.number().minValue(1), // number, >=1
    name: adjuster.string().maxLength(16, true), // string, max 16 characters (trims if over)
    age: adjuster.number().integer(true).minValue(0), // number, integer (trims if decimal), >=0
    email: adjuster.email(), // email
    state: adjuster.string().only("active", "inactive"), // string, accepts only "active" and "inactive"
    classes: adjuster.array().separatedBy(",").each(adjuster.number(), true), // array of number, separated by ",", ignores errors
    skills: adjuster.array().separatedBy(",").each(adjuster.string(), true), // array of string, separated by ",", ignores errors
    credit_card: adjuster.numericString().separatedBy("-").checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.CREDIT_CARD), // numeric string, separated by "-", checks by Luhn algorithm
    remote_addr: adjuster.string().pattern(adjuster.STRING.PATTERN.IPV4), // IPv4
    remote_addr_ipv6: adjuster.string().pattern(adjuster.STRING.PATTERN.IPV6), // IPv6
    limit: adjuster.number().integer().default(10).minValue(1, true).maxValue(100, true), // number, integer, omittable (sets 10 if omitted), >=1 (sets 1 if less), <=100 (sets 100 if greater)
    offset: adjuster.number().integer().default(0).minValue(0, true), // number, integer, omittable (sets 0 if omitted), >=0 (sets 0 if less)
};
const input = { // input values
    id: "1",
    name: "Pablo Diego José Francisco de Paula Juan Nepomuceno María de los Remedios Ciprin Cipriano de la Santísima Trinidad Ruiz y Picasso",
    age: 20.5,
    email: "picasso@example.com",
    state: "active",
    classes: "1,3,abc,4",
    skills: "c,c++,javascript,python,,swift,kotlin",
    credit_card: "4111-1111-1111-1111",
    remote_addr: "127.0.0.1",
    remote_addr_ipv6: "::1",
    limit: "0",
};
const expected = { // should be adjusted to this
    id: 1,
    name: "Pablo Diego José",
    age: 20,
    email: "picasso@example.com",
    state: "active",
    classes: [1, 3, 4],
    skills: ["c", "c++", "javascript", "python", "swift", "kotlin"],
    credit_card: "4111111111111111",
    remote_addr: "127.0.0.1",
    remote_addr_ipv6: "::1",
    limit: 1,
    offset: 0,
};

// Let's adjust!
const adjusted = adjuster.adjust(input, constraints);

// verification
assert.deepStrictEqual(adjusted, expected);

That’s all! No control flows! Isn’t it cool?

For details, see basic usage.

Install

install from npm registry.

npm install -S adjuster

NOTE: package name is adjuster, NOT node-adjuster!

Loading

CommonJS

// foo.js
var adjuster = require("adjuster");

ES Modules

// foo.mjs
import adjuster from "adjuster";

TypeScript

// foo.ts
import * as adjuster from "adjuster";

ES6 Modules with Babel

// same as ES Modules!
import adjuster from "adjuster";

Reference

types and constants

`AdjusterError`

The AdjusterError object represents an error when trying to adjust invalid value.

ambient declaration

interface AdjusterError extends Error
{
    name: string
    message: string
    cause: string
    value: any
    keyStack: (string | number)[]
}

properties

name	description
`name`	`"AdjusterError"`
`message`	human-readable description of the error, including a string `cause`
`cause`	cause of adjustment error; see `adjuster.CAUSE`
`value`	value to adjust
`keyStack`	array consists of path to key name(for object) or index(for array) that caused error; for nested object or array

See below example. For detail about constraints / adjuster, see basic usage

import adjuster from "adjuster";
import assert from "assert";

// {foo: Array<{bar: {baz: number}}>}
const constraints = {
    foo: adjuster.array().each(adjuster.object().constraints({
        bar: adjuster.object().constraints({
            baz: adjuster.number(),
        }),
    })),
};
const input = {
    foo: [
        {
            bar: {
                baz: 1,
            },
        },
        {
            bar: {
                baz: 2,
            },
        },
        { // index 2
            bar: {
                baz: "three", // ERROR!
            },
        },
        {
            bar: {
                baz: 4,
            },
        },
    ],
};
assert.throws(
    () => {
        adjuster.adjust(input, constraints);
    },
    (err) => {
        assert.strictEqual(err.name, "AdjusterError");
        assert.strictEqual(err.cause, adjuster.CAUSE.TYPE),
        assert.deepStrictEqual(err.keyStack, ["foo", 2, "bar", "baz"]); // route to error key/index: object(key="foo") -> array(index=2) -> object(key="bar") -> object(key="baz")
        return true;
    });

`adjuster.CAUSE`

The cause of adjustment error.

For more information, see below examples.

`adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM`

Checksum algorithms for adjuster.numericString().checksum().

For more information, see numeric string.

`adjuster.STRING.PATTERN`

Regular expressions for adjuster.string().pattern().

For more information, see string.

basic usage

ambient declarations

namespace adjuster {
    export declare function adjust<T = any>(data: any, constraints: Object, onError?: (err: AdjusterError | null) => any): T;
}

`adjuster.adjust(data, constraints[, onError])`

Validate and adjust a input value.

`data`

An object to adjust; e.g., req.query, req.body (in Express)

data will not be overwritten.

`constraints`

Constraints object for adjustment.

key: the name of data to adjust value
value: the adjustment object; see below examples

`onError(err)`

Callback function for each errors. If no errors, this function will not be called.

If this parameter is omitted, adjuster.adjust() throws AdjusterError on first error and remaining adjustment process will be cancelled.

err
- an instance of AdjusterError or null
- err.keyStack indicates path to key name that caused error: (string | number)[]
- err will be null after all adjustment has finished and errors has occurred
  - onError() will no longer be called after null passed
returns
- an adjuted value
- undefined means this key will not be included in returned object from adjuster.adjust()
- return value of onError(null) is ignored
throws
- an exception that will thrown from adjuster.adjust()
- remaining adjustment processes will be cancelled

examples

successful

For more information, see below references about adjuster.number(), adjuster.string(), and so on.

import adjuster from "adjuster";
import assert from "assert";

const constraints = {
    id: adjuster.number().minValue(1),
    name: adjuster.string().maxLength(16, true),
    age: adjuster.number().integer(true).minValue(0),
    email: adjuster.email(),
    state: adjuster.string().only("active", "inactive"),
    classes: adjuster.array().separatedBy(",").each(adjuster.number(), true), // "true" means to ignore each errors
    skills: adjuster.array().separatedBy(",").each(adjuster.string(), true),
    credit_card: adjuster.numericString().separatedBy("-").checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.CREDIT_CARD),
    remote_addr: adjuster.string().pattern(adjuster.STRING.PATTERN.IPV4),
    remote_addr_ipv6: adjuster.string().pattern(adjuster.STRING.PATTERN.IPV6),
    limit: adjuster.number().integer().default(10).minValue(1, true).maxValue(100, true),
    offset: adjuster.number().integer().default(0).minValue(0, true),
};
const input = {
    id: "1",
    name: "Pablo Diego José Francisco de Paula Juan Nepomuceno María de los Remedios Ciprin Cipriano de la Santísima Trinidad Ruiz y Picasso",
    age: 20.5,
    email: "picasso@example.com",
    state: "active",
    classes: "1,3,abc,4",
    skills: "c,c++,javascript,python,,swift,kotlin",
    credit_card: "4111-1111-1111-1111",
    remote_addr: "127.0.0.1",
    remote_addr_ipv6: "::1",
    limit: "0",
};
const expected = {
    id: 1,
    name: "Pablo Diego José",
    age: 20,
    email: "picasso@example.com",
    state: "active",
    classes: [1, 3, 4],
    skills: ["c", "c++", "javascript", "python", "swift", "kotlin"],
    credit_card: "4111111111111111",
    remote_addr: "127.0.0.1",
    remote_addr_ipv6: "::1",
    limit: 1,
    offset: 0,
};

const adjusted = adjuster.adjust(input, constraints);
assert.deepStrictEqual(adjusted, expected);

In TypeScript, use Generics for type-safe.

interface Parameters {
    foo: number
    bar: string
}

const constraints = {
    foo: adjuster.number(),
    bar: adjuster.string(),
};
const input = {
    foo: "12345",
    bar: "abcde",
};

const adjusted = adjuster.adjust<Parameters>(input, constraints);

error handling 1

adjust errors

import adjuster from "adjuster";
import assert from "assert";

const constraints = {
    id: adjuster.number().minValue(1),
    name: adjuster.string().maxLength(16, true),
    email: adjuster.email(),
};
const input = {
    id: 0, // error! (>= 1)
    name: "", // error! (empty string is not allowed)
    email: "john@example.com", // OK
};
const expected = {
    id: 100,
    email: "john@example.com",
};

const adjusted = adjuster.adjust(input, constraints, generateErrorHandler());
assert.deepStrictEqual(adjusted, expected);

function generateErrorHandler() {
    return (err) => {
        if (err === null) {
            // adjustment finished
            return;
        }

        const key = err.keyStacks.shift(); // ["id"]
        if (key === "id") {
            // adjust to 100 on `id` error
            return 100;
        }
        // remove otherwise
    };
}

error handling 2

throw exception after finished

import adjuster from "adjuster";
import assert from "assert";

const constraints = {
    id: adjuster.number().minValue(1),
    name: adjuster.string().maxLength(16, true),
    email: adjuster.email(),
};
const input = {
    id: 0, // error! (>= 1)
    name: "", // error! (empty string is not allowed)
    email: "john@example.com", // OK
};

try {
    adjuster.adjust(input, constraints, generateErrorHandler());
}
catch (err) {
    // do something
    assert.strictEqual(err.message, "id,name");
}

function generateErrorHandler() {
    const messages = [];
    return (err) => {
        if (err === null) {
            // adjustment finished; join key name as message
            throw new Error(messages.join(","));
        }

        // append key name
        const key = err.keyStacks.shift(); // ["id"]
        messages.push(key);
    };
}

error handling 3

catch a first error by omitting error handler

import adjuster from "adjuster";
import assert from "assert";

const constraints = {
    id: adjuster.number().minValue(1),
    name: adjuster.string().maxLength(16, true),
    email: adjuster.email(),
};
const input = {
    id: 0, // error! (>= 1)
    name: "", // error! (empty string is not allowed)
    email: "john@example.com", // OK
};

try {
    const adjusted = adjuster.adjust(input, constraints);
}
catch (err) {
    // catch a first error
    assert.deepStrictEqual(err.keyStack, ["id"]);
}

error handling 4

when input value is not an object

NOTE: constraint won’t be checked because it’s predictable; should be generated by programmer, not an external input

import adjuster from "adjuster";
import assert from "assert";

const constraints = {};
const input = 123;

try {
    // `input` must be an object
    const adjusted = adjuster.adjust(input, constraints);
}
catch (err) {
    assert.deepStrictEqual(err.keyStack, []);
    assert.strictEqual(err.cause, adjuster.CAUSE.TYPE);
}

boolean

ambient declarations

namespace adjuster {
    export declare function boolean(): BooleanAdjuster;
}

interface BooleanAdjuster {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => boolean | void): number;

    // feature methods (chainable)
    strict(): this;
    acceptAllNumbers(): this;
    default(value: boolean): this;
    acceptNull(value?: boolean | null /* = null */): this;
    acceptEmptyString(value?: boolean | null /* = null */): this;
}

`adjust(value[, onError])`

Validate and adjust a input value.

If an error occurs, call onError (if specified) or throw AdjusterError (otherwise)

examples

// should be OK
assert.strictEqual(
    adjuster.boolean().adjust(true),
    true);
assert.strictEqual(
    adjuster.boolean().adjust(false),
    false);

// should be adjusted
assert.strictEqual(
    adjuster.boolean().adjust(1),
    true);
assert.strictEqual(
    adjuster.boolean().adjust(0),
    false);
assert.strictEqual(
    adjuster.boolean().adjust("1"),
    true);
assert.strictEqual(
    adjuster.boolean().adjust("0"), // "0" is truthy in JavaScript, but node-adjuster adjusts to false!
    false);
assert.strictEqual(
    adjuster.boolean().adjust("true"), // "true" / "yes" / "on" are true, "false" / "no" / "off" are false!
    true);
assert.strictEqual(
    adjuster.boolean().adjust("TRUE"),
    true);
assert.strictEqual(
    adjuster.boolean().adjust("yes"),
    true);
assert.strictEqual(
    adjuster.boolean().adjust("YES"),
    true);
assert.strictEqual(
    adjuster.boolean().adjust("on"),
    true);
assert.strictEqual(
    adjuster.boolean().adjust("ON"),
    true);
assert.strictEqual(
    adjuster.boolean().adjust("false"),
    false);
assert.strictEqual(
    adjuster.boolean().adjust("FALSE"),
    false);
assert.strictEqual(
    adjuster.boolean().adjust("no"),
    false);
assert.strictEqual(
    adjuster.boolean().adjust("NO"),
    false);
assert.strictEqual(
    adjuster.boolean().adjust("off"),
    false);
assert.strictEqual(
    adjuster.boolean().adjust("OFF"),
    false);

// should cause error
assert.throws(
    () => adjuster.boolean().adjust(-1), // accepts only 0,1
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.boolean().adjust("abc"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.boolean().adjust([]),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.boolean().adjust({}),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`strict()`

Enable strict type check.

HANDLE WITH CARE! In URL encoding, all values will be treated as string. Use this method when your system accepts ONLY JSON encoding (application/json)

examples

// should cause error
assert.throws(
    () => adjuster.boolean().strict().adjust(1),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.boolean().strict().adjust("1"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.boolean().strict().adjust("true"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`acceptAllNumbers()`

Accept all numbers, other than 0 / 1.

examples

// should be adjusted
assert.strictEqual(
    adjuster.boolean().acceptAllNumbers().adjust(-1),
    true);
assert.strictEqual(
    adjuster.boolean().acceptAllNumbers().adjust("100"),
    true);

`default(value)`

Accept undefined for input, and adjust to value.

If this method is not called, adjust(undefined) causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.boolean().default(true).adjust(undefined),
    true);

// should cause error
assert.throws(
    () => adjuster.boolean().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

If this method is not called, adjust(null) causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.boolean().acceptNull(true).adjust(null),
    true);

// should cause error
assert.throws(
    () => adjuster.boolean().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

If this method is not called, adjust("") causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.boolean().acceptEmptyString(true).adjust(""),
    true);

// should cause error
assert.throws(
    () => adjuster.boolean().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

number

ambient declarations

namespace adjuster {
    export declare function number(): NumberAdjuster;
}

interface NumberAdjuster {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => number | void): number;

    // feature methods (chainable)
    strict(): this;
    default(value: number): this;
    acceptNull(value?: number | null /* = null */): this;
    acceptEmptyString(value?: number | null /* = null */): this;
    acceptSpecialFormats(): this;
    acceptFullWidth(): this;
    integer(adjust?: boolean /* = false */): this;
    only(...values: number[]): this;
    minValue(value: number, adjust?: boolean /* = false */): this;
    maxValue(value: number, adjust?: boolean /* = false */): this;
    convert(converter: (value: number, fail: () => never) => number): this;
    // deprecated; use convert()
    map(mapper: (value: number, fail: () => never) => number): this;
}

`adjust(value[, onError])`

Validate and adjust a input value.

If an error occurs, call onError (if specified) or throw AdjusterError (otherwise)

examples

// should be OK
assert.strictEqual(
    adjuster.number().adjust(-123),
    -123);

// should be adjusted
assert.strictEqual(
    adjuster.number().adjust("-123"),
    -123);
assert.strictEqual(
    adjuster.number().adjust(true),
    1);
assert.strictEqual(
    adjuster.number().adjust(false),
    0);

// should cause error
assert.strictEqual( // catch error by callback function (that returns a value from adjust() method)
    adjuster.number().adjust(
        "abc",
        (err) => 10),
    10);
assert.throws( // ... or try-catch syntax
    () => adjuster.number().adjust("abc"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.number().adjust("true"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`strict()`

Enable strict type check.

HANDLE WITH CARE! In URL encoding, all values will be treated as string. Use this method when your system accepts ONLY JSON encoding (application/json)

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().adjust("123"),
    123);
assert.strictEqual(
    adjuster.number().adjust(true),
    1);

// should cause error
assert.throws(
    () => adjuster.number().strict().adjust("123"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.number().strict().adjust(true),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`default(value)`

Accept undefined for input, and adjust to value.

If this method is not called, adjust(undefined) causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().default(1).adjust(undefined),
    1);

// should cause error
assert.throws(
    () => adjuster.number().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

If this method is not called, adjust(null) causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().acceptNull(1).adjust(null),
    1);

// should cause error
assert.throws(
    () => adjuster.number().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

If this method is not called, adjust("") causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().acceptEmptyString(1).adjust(""),
    1);

// should cause error
assert.throws(
    () => adjuster.number().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`acceptSpecialFormats()`

Accept all special number formats; e.g., "1e+2", "0x100", "0o100", "0b100".

If this method is not called, the above examples causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().acceptSpecialFormats().adjust("1e+2"),
    100);
assert.strictEqual(
    adjuster.number().acceptSpecialFormats().adjust("0x100"),
    256);
assert.strictEqual(
    adjuster.number().acceptSpecialFormats().adjust("0o100"),
    64);
assert.strictEqual(
    adjuster.number().acceptSpecialFormats().adjust("0b100"),
    4);

// should cause error
assert.throws(
    () => adjuster.number().adjust("1e+2"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`acceptFullWidth()`

Accept full-width string; e.g., "１２３４．５", "1２3４.５".

If this method is not called, the above examples causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().acceptFullWidth().adjust("１２３４．５"),
    1234.5);

// should cause error
assert.throws(
    () => adjuster.number().adjust("１２３４．５"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`integer([adjust])`

Limit an input value to integer.

If adjust is true, value will be adjusted to an integer.

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().integer(true).adjust(3.14),
    3);
assert.strictEqual(
    adjuster.number().integer(true).adjust("3.14"),
    3);
assert.strictEqual(
    adjuster.number().integer(true).adjust(-3.14),
    -3);
assert.strictEqual(
    adjuster.number().integer(true).adjust("-3.14"),
    -3);

// should cause error
assert.throws(
    () => adjuster.number().integer().adjust(3.14),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.number().integer().adjust("3.14"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.number().integer().adjust("3."),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`only(...values)`

Accept only values.

If input value is not in values, adjust() method causes AdjusterError.

examples

// should be OK
assert.strictEqual(
    adjuster.number().only(1, 3, 5).adjust(1),
    1);

// should cause error
assert.throws(
    () => adjuster.number().only(1, 3, 5).adjust(2),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.ONLY));

`minValue(value[, adjust])`

Limit minimum value to value.

If input value is less than value, adjust() method returns value (if adjust is truthy) or causes AdjusterError (falsy; default).

By default, value equals Number.MIN_SAFE_INTEGER.

examples

// should be OK
assert.strictEqual(
    adjuster.number().adjust(Number.MIN_SAFE_INTEGER),
    Number.MIN_SAFE_INTEGER);
assert.strictEqual(
    adjuster.number().minValue(1).adjust(1),
    1);

// should be adjusted
assert.strictEqual(
    adjuster.number().minValue(1, true).adjust(0),
    1);

// should cause errors
assert.throws(
    () => adjuster.number().adjust(Number.MIN_SAFE_INTEGER - 1),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MIN_VALUE));
assert.throws(
    () => adjuster.number().minValue(1).adjust(0),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MIN_VALUE));

`maxValue(value[, adjust])`

Limit maximum value to value.

If input value is greater than value, adjust() method returns value (if adjust is truthy) or causes AdjusterError (falsy; default).

By default, value equals Number.MAX_SAFE_INTEGER.

examples

// should be OK
assert.strictEqual(
    adjuster.number().adjust(Number.MAX_SAFE_INTEGER),
    Number.MAX_SAFE_INTEGER);
assert.strictEqual(
    adjuster.number().maxValue(1).adjust(1),
    1);

// should be adjusted
assert.strictEqual(
    adjuster.number().maxValue(100, true).adjust(101),
    100);

// should cause errors
assert.throws(
    () => adjuster.number().adjust(Number.MAX_SAFE_INTEGER + 1),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_VALUE));
assert.throws(
    () => adjuster.number().maxValue(100).adjust(101),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_VALUE));

`convert(converter)` / `map(mapper)`

Convert input value into another value.

WARNING; map() is deprecated. use convert().

examples

// should be adjusted
assert.strictEqual(
    adjuster.number().convert(value => value + 1).adjust(100)
    101);

// should cause errors
assert.throws(
    () => adjuster.number().convert((value, fail) => fail()).adjust(100),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.CONVERT));

string

ambient declarations

namespace adjuster {
    export declare function string(): StringAdjuster;
}

interface StringAdjuster {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => string | void): string;

    // feature methods (chainable)
    strict(): this;
    default(value: string): this;
    acceptNull(value?: string | null /* = null */): this;
    acceptEmptyString(value?: string | null /* = null */): this;
    trim(): this;
    only(...values: string[]): this;
    minLength(length: number): this;
    maxLength(length: number, adjust?: boolean /* = false */): this;
    pattern(pattern: RegExp): this;
    convert(converter: (value: string, fail: () => never) => string): this;
    // deprecated; use convert()
    map(mapper: (value: string, fail: () => never) => string): this;
}

`adjust(value[, onError])`

Validate and adjust a input value.

examples

// should be OK
assert.strictEqual(
    adjuster.string().adjust("123"),
    "123");

// should be adjusted
assert.strictEqual(
    adjuster.string().adjust(123),
    "123");

`strict()`

Enable strict type check.

examples

// should be adjusted
assert.strictEqual(
    adjuster.string().adjust(123),
    "123");
assert.strictEqual(
    adjuster.string().adjust(true),
    "true");

// should cause error
assert.throws(
    () => adjuster.string().strict().adjust(123),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.string().strict().adjust(true),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`default(value)`

Accept undefined for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.string().default("xyz").adjust(undefined),
    "xyz");

// should cause error
assert.throws(
    () => adjuster.string().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

If this method is not called, adjust(null) causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.string().acceptNull("x").adjust(null),
    "x");

// should cause error
assert.throws(
    () => adjuster.string().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.string().acceptEmptyString("xyz").adjust(""),
    "xyz");

// should cause error
assert.throws(
    () => adjuster.string().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`trim()`

Remove whitespace from both ends of input.

examples

// should be adjusted
assert.strictEqual(
    adjuster.string().trim().adjust("\r\n hell, word \t "),
    "hell, word");

// should cause error
assert.throws(
    () => adjuster.string().trim().adjust(" \t\r\n "),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`only(...values)`

Accept only values.

examples

// should be OK
assert.strictEqual(
    adjuster.string().only("eat", "sleep", "play").adjust("sleep"),
    "sleep");
assert.strictEqual(
    adjuster.string().only("").adjust(""),
    "");

// should cause error
assert.throws(
    () => adjuster.string().only("eat", "sleep", "play").adjust("study"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.ONLY));

`minLength(length)`

Limit minimum length of input string to length.

examples

// should be OK
assert.strictEqual(
    adjuster.string().minLength(5).adjust("abcde"),
    "abcde");

// should cause error
assert.throws(
    () => adjuster.string().minLength(5).adjust("a"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MIN_LENGTH));

`maxLength(length[, adjust])`

Limit maximum length of an input string to length.

If string length is greater than length, adjust() method truncates the length to length (if adjust is truthy) or causes AdjusterError (falsy; default).

examples

// should be OK
assert.strictEqual(
    adjuster.string().maxLength(5).adjust("abcde"),
    "abcde");

// should be adjusted
assert.strictEqual(
    adjuster.string().maxLength(5, true).adjust("abcdefg"),
    "abcde");

// should cause error
assert.throws(
    () => adjuster.string().maxLength(5).adjust("abcdefg"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_LENGTH));

`pattern(pattern)`

Specify acceptable pattern by regular expression.

You can also use adjuster.STRING.PATTERN constants

constant	explanation
`adjuster.STRING.PATTERN.EMAIL`	email address that follows RFC5321 / RFC5322
`adjuster.STRING.PATTERN.HTTP`	HTTP/HTTPS URL
`adjuster.STRING.PATTERN.IPV4`	IPv4 address
`adjuster.STRING.PATTERN.IPV6`	IPv6 address
`adjuster.STRING.PATTERN.URI`	URI that follows RFC3986

examples

// should be OK
assert.deepStrictEqual(
    adjuster.string().pattern(/^Go+gle$/).adjust("Gogle"),
    "Gogle");
assert.deepStrictEqual(
    adjuster.string().pattern(adjuster.STRING.PATTERN.URI).adjust("https://example.com/path/to/resource?name=value#hash"),
    "https://example.com/path/to/resource?name=value#hash");


// should cause error
assert.throws(
    () => adjuster.string().pattern(/^Go+gle$/).adjust("Ggle"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.string().pattern(adjuster.STRING.PATTERN.URI).adjust("https://例.com/"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));

`convert(converter)` / `map(mapper)`

Convert input value into another value.

WARNING; map() is deprecated. use convert().

examples

// should be adjusted
assert.strictEqual(
    adjuster.string().convert(value => value + value).adjust("abc")
    "abcabc");

// should cause errors
assert.throws(
    () => adjuster.string().convert((value, fail) => fail()).adjust("abc"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.CONVERT));

numeric string

ambient declarations

namespace adjuster {
    export declare function numericString(): NumericStringAdjuster;
}

interface NumericStringAdjuster {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => string | void): string;

    // feature methods (chainable)
    default(value: string): this;
    acceptNull(value?: string | null /* = null */): this;
    acceptEmptyString(value?: string | null /* = null */): this;
    fullWidthToHalf(): this;
    joinArray(): this;
    separatedBy(separator: string | RegExp): this;
    minLength(length: number): this;
    maxLength(length: number, adjust?: boolean /* = false */): this;
    checksum(algorithm: string): this;
    convert(converter: (value: string, fail: () => never) => string): this;
    // deprecated; use convert()
    map(mapper: (value: string, fail: () => never) => string): this;
}

`adjust(value[, onError])`

Validate and adjust input values.

examples

// should be OK
assert.strictEqual(
    adjuster.numericString().adjust("123"),
    "123");

// should be adjusted
assert.strictEqual(
    adjuster.numericString().adjust(123),
    "123");

`default(value)`

Accpet undefined for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().default("123").adjust(undefined),
    "123");

// should cause error
assert.throws(
    () => adjuster.numericString().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().acceptNull("456").adjust(null),
    "456");

// should cause error
assert.throws(
    () => adjuster.numericString().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().acceptEmptyString("456").adjust(""),
    "456");

// should cause error
assert.throws(
    () => adjuster.numericString().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`separatedBy(separator)`

Assume an input value is separated by separator, and ignore them.

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().separatedBy("-").adjust("4111-1111-1111-1111"),
    "4111111111111111");

// should cause error
assert.throws(
    () => adjuster.numericString().adjust("4111-1111-1111-1111"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));

`fullWidthToHalf()`

Convert full-width string to half-width; e.g., "１２３４".

If this method is not called, the above examples causes AdjusterError.

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().fullWidthToHalf().adjust("１２３４"),
    "1234");

// should cause error
assert.throws(
    () => adjuster.numericString().adjust("１２３４"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));

`joinArray()`

Assume an input value is array, and join them.

This method is useful for following form.

<!-- "cc_number" will be passed in array -->
<form>
    Input credit card number:
    <input name="cc_number" required />
    -
    <input name="cc_number" required />
    -
    <input name="cc_number" required />
    -
    <input name="cc_number" required />
</form>

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().joinArray().adjust(["1234", "5678"]),
    "12345678");

// should cause error
assert.throws(
    () => adjuster.numericString().adjust(["1234", "5678"]),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`minLength(length)`

Limit minimum length of input string to length.

examples

// should be OK
assert.strictEqual(
    adjuster.numericString().minLength(4).adjust("1234"),
    "1234");

// should cause error
assert.throws(
    () => adjuster.numericString().minLength(5).adjust("1234"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MIN_LENGTH));

`maxLength(length[, adjust])`

Limit maximum length of an input string to length.

examples

// should be OK
assert.strictEqual(
    adjuster.numericString().maxLength(4).adjust("1234"),
    "1234");

// should be adjusted
assert.strictEqual(
    adjuster.numericString().separatedBy("-").maxLength(5, true).adjust("1234-5678"),
    "12345");

// should cause error
assert.throws(
    () => adjuster.numericString().maxLength(5).adjust("123456"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_LENGTH));

`checksum(algorithm)`

Check an input value by specified algorithm.

algorithm name	explanation	used by	constant	aliases
`"luhn"`	Luhn algorithm	credit card	`adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.LUHN`	`adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.CREDIT_CARD`
`"modulus10/weight3:1"`	Modulus 10 / Weight 3:1	ISBN-13, EAN, JAN	`adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.MODULUS10_WEIGHT3_1`	`adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.ISBN13` / `adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.EAN` / `adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.JAN`

examples

// should be OK
assert.strictEqual(
    adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.LUHN).adjust("4111111111111111"),
    "4111111111111111");
assert.strictEqual(
    adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.CREDIT_CARD).adjust("4111111111111111"), // alias of LUHN
    "4111111111111111");
assert.strictEqual(
    adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.MODULUS10_WEIGHT3_1).adjust("9784101092058"),
    "9784101092058");
assert.strictEqual(
    adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.ISBN13).adjust("9784101092058"), // alias of MODULUS10_WEIGHT3_1
    "9784101092058");
assert.strictEqual(
    adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.EAN).adjust("9784101092058"), // alias of MODULUS10_WEIGHT3_1
    "9784101092058");
assert.strictEqual(
    adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.JAN).adjust("9784101092058"), // alias of MODULUS10_WEIGHT3_1
    "9784101092058");

// should cause error
assert.throws(
    () => adjuster.numericString().checksum(adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM.LUHN).adjust("4111111111111112"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.CHECKSUM));

`convert(converter)` / `map(mapper)`

Convert input value into another value.

WARNING; map() is deprecated. use convert().

examples

// should be adjusted
assert.strictEqual(
    adjuster.numericString().convert(value => value.substr(0, 4) + "-" + value.substr(4)).adjust("12345678")
    "1234-5678");

// should cause errors
assert.throws(
    () => adjuster.numericString().convert((value, fail) => fail()).adjust("abc"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.CONVERT));

email

ambient declarations

namespace adjuster {
    export declare function email(): EmailAdjuster;
}

interface EmailAdjuster {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => string | void): string;

    // feature methods (chainable)
    default(value: string): this;
    acceptNull(value?: string | null /* = null */): this;
    acceptEmptyString(value?: string | null /* = null */): this;
    trim(): this;
    pattern(pattern: RegExp): this;
}

`adjust(value[, onError])`

Validate and adjust a input value.

examples

// should be OK
assert.strictEqual(
    adjuster.email().adjust("user+mailbox/department=shipping@example.com"),
    "user+mailbox/department=shipping@example.com"); // dot-string
assert.strictEqual(
    adjuster.email().adjust("!#$%&'*+-/=?^_`.{|}~@example.com"),
    "!#$%&'*+-/=?^_`.{|}~@example.com"); // dot-string
assert.strictEqual(
    adjuster.email().adjust("\"Fred\\\"Bloggs\"@example.com"),
    "\"Fred\\\"Bloggs\"@example.com"); // quoted-string
assert.strictEqual(
    adjuster.email().adjust("\"Joe.\\\\Blow\"@example.com"),
    "\"Joe.\\\\Blow\"@example.com"); // quoted-string
assert.strictEqual(
    adjuster.email().adjust("user@example-domain.com"),
    "user@example-domain.com");
assert.strictEqual(
    adjuster.email().adjust("user@example2.com"),
    "user@example2.com");

// should cause error
assert.throws(
    () => adjuster.email().adjust("@example.com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust(".a@example.com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust("a.@example.com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust("a..a@example.com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust("user@example@com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust("user-example-com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust("user@example_domain.com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().adjust("user@example.com2"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));

`default(value)`

Accept undefined for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.email().default("user@example.com").adjust(undefined),
    "user@example.com");

// should cause error
assert.throws(
    () => adjuster.email().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.email().acceptNull("user@example.com").adjust(null),
    "user@example.com");

// should cause error
assert.throws(
    () => adjuster.email().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

examples

// should be adjusted
assert.strictEqual(
    adjuster.email().acceptEmptyString("user@example.com").adjust(""),
    "user@example.com");

// should cause error
assert.throws(
    () => adjuster.email().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`trim()`

Remove whitespace from both ends of input.

examples

// should be adjusted
assert.strictEqual(
    adjuster.email().trim().adjust("\r\n user@example.com \t "),
    "user@example.com");

// should cause error
assert.throws(
    () => adjuster.email().adjust("\r\n user@example.com1 \t "),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
    () => adjuster.email().trim().adjust(" \t\r\n "),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`pattern(pattern)`

Specify acceptable pattern by regular expression.

examples

// should be OK
assert.strictEqual(
    adjuster.email().pattern(/^[\w\.]+@([\w\-]+\.)+\w+$/).adjust("......@example.com"), // accept leading/trailing/consecutively dots
    "user@example.com");

// should cause errors
assert.throws(
    () => adjuster.email().adjust("......@example.com"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));

array

ambient declarations

namespace adjuster {
    export declare function array<T = any>(): ArrayAdjuster;
}

interface ArrayAdjuster<T> {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => Array | void): T[];

    // feature methods (chainable)
    default(value: Array): this;
    acceptNull(value?: Array | null /* = null */): this;
    acceptEmptyString(value: Array | null /* = null */): this;
    separatedBy(separator: string | RegExp): this;
    toArray(): this;
    minLength(length: number): this;
    maxLength(length: number, adjust?: boolean /* = false */): this;
    each(adjusterInstance: AdjusterBase, ignoreEachErrors: boolean /* = false */): this;
}

`adjust(value[, onError])`

Validate and adjust input values.

examples

// should be OK
assert.deepStrictEqual(
    adjuster.array().adjust([1, "a"]),
    [1, "a"]);

// should cause error
assert.throws(
    () => adjuster.array().adjust("abc"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.array().adjust(0),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`default(value)`

Accept undefined for input, and adjust to value.

If this method is not called, adjust(undefined) causes AdjusterError.

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().default([1, "a"]).adjust(undefined),
    [1, "a"]);

// should cause error
assert.throws(
    () => adjuster.array().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

If this method is not called, adjust(null) causes AdjusterError.

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().acceptNull([1, "a"]).adjust(null),
    [1, "a"]);

// should cause error
assert.throws(
    () => adjuster.array().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

If this method is not called, adjust("") causes AdjusterError.

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().acceptEmptyString([1, "a"]).adjust(""),
    [1, "a"]);

// should cause error
assert.throws(
    () => adjuster.array().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`separatedBy(separator)`

Assume an input value is string and separated by separator.

If an input type is array, this method does nothing.

examples

// should be OK
assert.deepStrictEqual(
    adjuster.array().separatedBy(",").adjust([1, 2, 3]),
    [1, 2, 3]);

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().separatedBy(",").adjust("1,2,3"),
    ["1", "2", "3"]);

// should cause error
assert.throws(
    () => adjuster.array().adjust("1,2,3"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`toArray()`

Convert an input value to array if not.

examples

// should be OK
assert.deepStrictEqual(
    adjuster.array().toArray().adjust([0]),
    [0]);

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().toArray().adjust(0),
    [0]);

// should cause error
assert.throws(
    () => adjuster.array().adjust(0),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`minLength(length)`

Limit minimum length of input array to length.

examples

// should be OK
assert.deepStrictEqual(
    adjuster.array().minLength(2).adjust([1, 2]),
    [1, 2]);

// should cause errors
assert.throws(
    () => adjuster.array().minLength(2).adjust([1]),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MIN_LENGTH));

`maxLength(length[, adjust])`

Limit maximum length of an input array to length.

If array length is greater than length, adjust() method truncates the length to length (if adjust is truthy) or causes AdjusterError (falsy; default).

examples

// should be OK
assert.deepStrictEqual(
    adjuster.array().maxLength(2).adjust([1, 2]),
    [1, 2]);

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().maxLength(2, true).adjust([1, 2, 3]),
    [1, 2]);

// should cause error
assert.throws(
    () => adjuster.array().maxLength(2).adjust([1, 2, 3]),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_LENGTH));

`each(adjusterInstance, [ignoreEachErrors])`

Apply constraints for each elements.

adjusterInstance
- Any above adjuster instance, e.g., adjuster.number(), adjuster.string()… adjuster.array()!
ignoreEachErrors
- If true, ignore the errors of each element.
- default is false

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.array().each(adjuster.number(), true).adjust([true, "abc", 2]),
    [1, 2]);

// should cause error
assert.throws(
    () => adjuster.array().each(adjuster.number()).adjust([true, "abc", 2]),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_TYPE));

object

ambient declarations

namespace adjuster {
    export declare function object<T = any>(): ObjectAdjuster;
}

interface ObjectAdjuster<T> {
    // adjustment method
    adjust(value: any, onError?: (err: AdjusterError) => Object | void): T;

    // feature methods (chainable)
    default(value: Object): this;
    acceptNull(value?: Object | null /* = null */): this;
    acceptEmptyString(value: Object | null /* = null */): this;
    constraints(constraints): ObjectAdjuster;
}

`adjust(value[, onError])`

Validate and adjust input values.

examples

// should be OK
assert.deepStrictEqual(
    adjuster.object().adjust({a: 1, b: 2}),
    {a: 1, b: 2});

// should cause error
assert.throws(
    () => adjuster.object().adjust("abc"),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
    () => adjuster.object().adjust(0),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

`default(value)`

Accept undefined for input, and adjust to value.

If this method is not called, adjust(undefined) causes AdjusterError.

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.object().default({a: 1, b: 2}).adjust(undefined),
    {a: 1, b: 2});

// should cause error
assert.throws(
    () => adjuster.object().adjust(undefined),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));

`acceptNull([value])`

Accept a null for input, and adjust to value.

If this method is not called, adjust(null) causes AdjusterError.

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.object().acceptNull({a: 1, b: 2}).adjust(null),
    {a: 1, b: 2});

// should cause error
assert.throws(
    () => adjuster.object().adjust(null),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));

`acceptEmptyString([value])`

Accept an empty string("") for input, and adjust to value.

If this method is not called, adjust("") causes AdjusterError.

examples

// should be adjusted
assert.deepStrictEqual(
    adjuster.object().acceptEmptyString({a: 1, b: 2}).adjust(""),
    {a: 1, b: 2});

// should cause error
assert.throws(
    () => adjuster.object().adjust(""),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));

`constraints(constraints)`

Assume an input value is string and separated by separator.

If an input type is array, this method does nothing.

examples

// should be OK
const constraints = {a: adjuster.number(), b: adjuster.string()};
assert.deepStrictEqual(
    adjuster.object().constraints(constraints).adjust({a: 1, b: "2"}),
    {a: 1, b: "2"});

// should be adjusted
assert.deepStrictEqual(
    adjuster.object().constraints(constraints).adjust({a: 1, b: 2}),
    {a: 1, b: "2"});

// should cause error
assert.throws(
    () => adjuster.object().constraints(constraints).adjust({a: "x", b: "2"}),
    (err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));

Changelog

See CHANGELOG.md.

node-adjuster

Table of Contents

Introduction

example

Install

Loading

CommonJS

ES Modules

TypeScript

ES6 Modules with Babel

Reference

types and constants

AdjusterError

ambient declaration

properties

adjuster.CAUSE

adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM

adjuster.STRING.PATTERN

basic usage

ambient declarations

adjuster.adjust(data, constraints[, onError])

data

constraints

onError(err)

examples

successful

error handling 1

error handling 2

error handling 3

error handling 4

boolean

ambient declarations

adjust(value[, onError])

examples

strict()

examples

acceptAllNumbers()

examples

default(value)

examples

acceptNull([value])

examples

acceptEmptyString([value])

examples

number

ambient declarations

adjust(value[, onError])

examples

strict()

examples

default(value)

examples

acceptNull([value])

examples

acceptEmptyString([value])

examples

acceptSpecialFormats()

examples

acceptFullWidth()

examples

integer([adjust])

examples

only(...values)

examples

minValue(value[, adjust])

examples

maxValue(value[, adjust])

examples

convert(converter) / map(mapper)

examples

string

ambient declarations

adjust(value[, onError])

examples

strict()

examples

default(value)

examples

acceptNull([value])

examples

`AdjusterError`

`adjuster.CAUSE`

`adjuster.NUMERIC_STRING.CHECKSUM_ALGORITHM`

`adjuster.STRING.PATTERN`

`adjuster.adjust(data, constraints[, onError])`

`data`

`constraints`

`onError(err)`

`adjust(value[, onError])`

`strict()`

`acceptAllNumbers()`

`default(value)`

`acceptNull([value])`

`acceptEmptyString([value])`

`adjust(value[, onError])`

`strict()`

`default(value)`

`acceptNull([value])`

`acceptEmptyString([value])`

`acceptSpecialFormats()`

`acceptFullWidth()`

`integer([adjust])`

`only(...values)`

`minValue(value[, adjust])`

`maxValue(value[, adjust])`

`convert(converter)` / `map(mapper)`

`adjust(value[, onError])`

`strict()`

`default(value)`

`acceptNull([value])`

`acceptEmptyString([value])`

`trim()`

`only(...values)`

`minLength(length)`

`maxLength(length[, adjust])`

`pattern(pattern)`

`convert(converter)` / `map(mapper)`

`adjust(value[, onError])`

`default(value)`

`acceptNull([value])`

`acceptEmptyString([value])`

`separatedBy(separator)`

`fullWidthToHalf()`

`joinArray()`

`minLength(length)`

`maxLength(length[, adjust])`

`checksum(algorithm)`

`convert(converter)` / `map(mapper)`

`adjust(value[, onError])`

`default(value)`

`acceptNull([value])`

`acceptEmptyString([value])`

`trim()`

`pattern(pattern)`

`adjust(value[, onError])`

`default(value)`

`acceptNull([value])`

`acceptEmptyString([value])`

`separatedBy(separator)`

`toArray()`

`minLength(length)`

`maxLength(length[, adjust])`