- v4.0.0Latest
- v3.1.2
- v4.0.0-rc.2
- v4.0.0-rc.1
- v3.1.1
- v3.1.0
- v3.0.0
- v3.0.0-rc.15
- v3.0.0-rc.14
- v3.0.0-rc.13
- v3.0.0-rc.12
- v3.0.0-rc.11
- v3.0.0-rc.10
- v3.0.0-rc.9
- v3.0.0-rc.8
- v3.0.0-rc.7
- v3.0.0-rc.6
- v3.0.0-rc.5
- v3.0.0-rc.4
- v3.0.0-rc.3
- v3.0.0-rc.2
- v3.0.0-rc.1
- v2.2.6
- v2.2.5
- v2.2.4
- v2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.0
- v2.0.0
- v1.4.0
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.1
- v1.0.0
- v1.0.0-rc.7
- v1.0.0-rc.6
- v1.0.0-rc.5
- v1.0.0-rc.4
- v1.0.0-rc.3
- v1.0.0-rc.2
- v1.0.0-rc.1
- v0.16.0
- v0.15.1
- v0.15.0
- v0.14.0
- v0.13.0
- v0.12.0
- v0.11.0
- v0.10.1
- v0.10.0
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- v0.1.0
node-adjuster
validate and adjust input values
Table of Contents
Install
install from npm registry.
npm install -S adjuster
Loading
Babel
usingimport adjuster from "adjuster";
CommonJS
var adjuster = require("adjuster").default;
or
var {default: adjuster} = require("adjuster");
ES Modules(.mjs
) is not provided for now.
Reference
types and constants
AdjusterError
The AdjusterError
object represents an error when trying to adjust invalid value.
properties
name | description |
---|---|
name |
"AdjusterError" |
message |
human-readable description of the error, including a string cause |
cause |
the cause of adjustment error; see adjuster.CAUSE |
value |
the value to adjust |
key |
key name that caused error; only filled in adjuster.adjust() , otherwise null |
adjuster.CAUSE
The cause of adjustment error.
For more information, see below examples.
adjuster.NUMERIC_STRING_CHECKSUM_ALGORITHM
Checksum algorithms for adjuster.numericString()
.
For more information, see numeric string.
basic usage
ambient declarations
namespace adjuster {
export declare function adjust(data: Object, constraints: Object, onError?: (err: AdjusterError|null) => any): Object;
}
adjuster.adjust(data, constraints[, onError])
Validate and adjust a input value.
data
An object to adjust; e.g. req.query
, req.body
(in Express)
This data
is not 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
ornull
err.key
indicates a key name that caused errorerr
will benull
after all adjustment has finished and errors has occurredonError()
will no longer be called afternull
passed
- an instance of
- returns
- an adjuted value
undefined
means this key will not be included in returned object fromadjuster.adjust()
- return value of
onError(null)
is ignored
- throws
- an exception that will thrown from
adjuster.adjust()
- remaining adjustment processes will be cancelled
- an exception that will thrown from
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),
email: adjuster.email(),
state: adjuster.string().only("active", "inactive"),
classes: adjuster.numberArray().separatedBy(",").ignoreEachErrors(),
skills: adjuster.stringArray().separatedBy(",").ignoreEachErrors(),
credit_card: adjuster.numericString().separatedBy("-").checksum(adjuster.NUMERIC_STRING_CHECKSUM_ALGORITHM.CREDIT_CARD),
remote_addr: adjuster.ipv4(),
remote_addr_ipv6: adjuster.ipv6(),
limit: adjuster.number().default(10).minValue(1, true).maxValue(100, true),
offset: adjuster.number().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",
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é",
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);
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;
}
if(err.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
messages.push(err.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.strictEqual(err.key, "id");
}
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)
default(value: number): NumberAdjuster;
allowNull(value?: number|null /* = null */): NumberAdjuster;
allowEmptyString(value?: number|null /* = null */): NumberAdjuster;
only(...values: number[]): NumberAdjuster;
minValue(value: number, adjust?: boolean /* = false */): NumberAdjuster;
maxValue(value: number, adjust?: boolean /* = false */): NumberAdjuster;
}
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);
// 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));
default(value)
Allow 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));
allowNull([value])
Allow 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().allowNull(1).adjust(null),
1);
// should cause error
assert.throws(
() => adjuster.number().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow 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().allowEmptyString(1).adjust(""),
1);
// should cause error
assert.throws(
() => adjuster.number().adjust(""),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));
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));
number array
ambient declarations
namespace adjuster {
export declare function numberArray(): NumberArrayAdjuster;
}
interface NumberArrayAdjuster {
// adjustment method
adjust(value: any, onError?: (err: AdjusterError) => number[]|void): number[];
// feature methods (chainable)
default(value: number[]): NumberArrayAdjuster;
allowNull(value?: number[]|null /* = null */): NumberArrayAdjuster;
allowEmptyString(value: number[]|null /* = null */): NumberArrayAdjuster;
separatedBy(separator: string|RegExp): NumberArrayAdjuster;
toArray(): NumberArrayAdjuster;
minLength(length: number): NumberArrayAdjuster;
maxLength(length: number, adjust?: boolean /* = false */): NumberArrayAdjuster;
ignoreEachErrors(): NumberArrayAdjuster;
eachDefault(value: number): NumberArrayAdjuster;
eachAllowNull(value?: number|null /* = null */): NumberArrayAdjuster;
eachAllowEmptyString(value?: number|null /* = null */): NumberArrayAdjuster;
eachOnly(...values: number[]): NumberArrayAdjuster;
eachMinValue(value: number, adjust?: boolean /* = false */): NumberArrayAdjuster;
eachMaxValue(value: number, adjust?: boolean /* = false */): NumberArrayAdjuster;
}
adjust(value[, onError])
Validate and adjust input values.
examples
// should be OK
assert.deepStrictEqual(
adjuster.numberArray().adjust([1, 2, 3]),
[1, 2, 3]);
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().adjust([1, "-2", "+3"]),
[1, -2, 3]);
// should cause error
assert.throws(
() => adjuster.numberArray().adjust("abc"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
assert.throws(
() => adjuster.numberArray().adjust(0),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
default(value)
Allow undefined
for input, and adjust to value
.
If this method is not called, adjust(undefined)
causes AdjusterError
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().default([1, 2]).adjust(undefined),
[1, 2]);
// should cause error
assert.throws(
() => adjuster.numberArray().adjust(undefined),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));
allowNull([value])
Allow 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.numberArray().allowNull([1, 2, 3]).adjust(null),
[1, 2, 3]);
// should cause error
assert.throws(
() => adjuster.numberArray().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow 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.numberArray().allowEmptyString([1, 2]).adjust(""),
[1, 2]);
// should cause error
assert.throws(
() => adjuster.numberArray().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.numberArray().separatedBy(",").adjust([1, 2, 3]),
[1, 2, 3]);
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().separatedBy(",").adjust("1,2,3"),
[1, 2, 3]);
// should cause error
assert.throws(
() => adjuster.numberArray().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.numberArray().toArray().adjust([0]),
[0]);
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().toArray().adjust(0),
[0]);
// should cause error
assert.throws(
() => adjuster.numberArray().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.numberArray().minLength(2).adjust([1, 2]),
[1, 2]);
// should cause errors
assert.throws(
() => adjuster.numberArray().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.numberArray().maxLength(2).adjust([1, 2]),
[1, 2]);
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().maxLength(2, true).adjust([1, 2, 3]),
[1, 2]);
// should cause error
assert.throws(
() => adjuster.numberArray().maxLength(2).adjust([1, 2, 3]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_LENGTH));
ignoreEachErrors()
Ignore the errors of each element.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().ignoreEachErrors().adjust([1, "abc", 2]),
[1, 2]);
// should cause error
assert.throws(
() => adjuster.numberArray().adjust([1, "abc", 2]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_TYPE));
eachDefault(value)
Allow undefined
for each elements of input, and adjust to value
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().eachDefault(2).adjust([1, undefined, 3]),
[1, 2, 3]);
// should cause error
assert.throws(
() => adjuster.numberArray().adjust([1, undefined, 3]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_REQUIRED));
eachAllowNull([value])
Allow a null
for each elements of input, and adjust to value
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().eachAllowNull(2).adjust([1, null, 3]),
[1, 2, 3]);
// should cause error
assert.throws(
() => adjuster.numberArray().adjust([1, null, 3]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_NULL));
eachAllowEmptyString([value])
Allow an empty string(""
) for each elements of input, and adjust to value
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().eachAllowEmptyString(2).adjust([1, "", 3]),
[1, 2, 3]);
// should cause eerror
assert.throws(
() => adjuster.numberArray().adjust([""]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_EMPTY));
eachOnly(...values)
Accept only values
for each elements of input.
examples
// should be OK
assert.deepStrictEqual(
adjuster.numberArray().eachOnly(1, 2, 3).adjust([1, 2]),
[1, 2]);
// should cause error
assert.throws(
() => adjuster.numberArray().eachOnly(1, 2, 3).adjust([0, 1]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_ONLY));
eachMinValue(value[, adjust])
Limit minimum value to value
for each elements of input.
If the element is less than value
, it will be adjusted to value
(if adjust
is truthy) or cause AdjusterError
(falsy; default).
examples
// should be OK
assert.deepStrictEqual(
adjuster.numberArray().eachMinValue(10).adjust([10, 11, 12]),
[10, 11, 12]);
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().ignoreEachErrors().eachMinValue(10).adjust([9, 10, 11]),
[10, 11]);
assert.deepStrictEqual(
adjuster.numberArray().eachMinValue(10, true).adjust([9, 10, 11]),
[10, 10, 11]);
// should cause errors
assert.throws(
() => adjuster.numberArray().eachMinValue(10).adjust([9, 10, 11]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_MIN_VALUE));
eachMaxValue(value[, adjust])
Limit maximum value to value
for each elements of input.
If the element is greater than value
, it will be adjusted to value
(if adjust
is truthy) or cause AdjusterError
(falsy; default).
examples
// should be OK
assert.deepStrictEqual(
adjuster.numberArray().eachMaxValue(10).adjust([8, 9, 10]),
[8, 9, 10]);
// should be adjusted
assert.deepStrictEqual(
adjuster.numberArray().ignoreEachErrors().eachMaxValue(10).adjust([9, 10, 11]),
[9, 10]);
assert.deepStrictEqual(
adjuster.numberArray().eachMaxValue(10, true).adjust([9, 10, 11]),
[9, 10, 10]);
// should cause errors
assert.throws(
() => adjuster.numberArray().eachMaxValue(10).adjust([9, 10, 11]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_MAX_VALUE));
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)
default(value: string): StringAdjuster;
allowNull(value?: string|null /* = null */): StringAdjuster;
allowEmptyString(value?: string|null /* = null */): StringAdjuster;
trim(): StringAdjuster;
only(...values: string[]): StringAdjuster;
minLength(length: number): StringAdjuster;
maxLength(length: number, adjust?: boolean /* = false */): StringAdjuster;
pattern(pattern: string|RegExp): StringAdjuster;
}
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");
default(value)
Allow 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));
allowNull([value])
Allow 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().allowNull("x").adjust(null),
"x");
// should cause error
assert.throws(
() => adjuster.string().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow an empty string(""
) for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.string().allowEmptyString("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.
examples
// should be OK
assert.deepStrictEqual(
adjuster.string().pattern(/^Go+gle$/).adjust("Gogle"),
"Gogle");
assert.deepStrictEqual(
adjuster.string().pattern("^Go+gle$").adjust("Google"),
"Google");
// should cause error
assert.throws(
() => adjuster.string().pattern(/^Go+gle$/).adjust("Ggle"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
string array
ambient declarations
namespace adjuster {
export declare function stringArray(): StringArrayAdjuster;
}
interface StringArrayAdjuster {
// adjustment method
adjust(value: any, onError?: (err: AdjusterError) => string[]|void): string[];
// feature methods (chainable)
default(value: string[]): StringArrayAdjuster;
allowNull(value?: string[]|null /* = null */): StringArrayAdjuster;
allowEmptyString(value: string[]|null /* = null */): StringArrayAdjuster;
separatedBy(separator: string|RegExp): StringArrayAdjuster;
toArray(): StringArrayAdjuster;
minLength(length: number): StringArrayAdjuster;
maxLength(length: number, adjust?: boolean /* = false */): StringArrayAdjuster;
ignoreEachErrors(): StringArrayAdjuster;
eachDefault(value: string): StringArrayAdjuster;
eachAllowNull(value?: string|null /* = null */): StringArrayAdjuster;
eachAllowEmptyString(value?: string|null /* = null */): StringArrayAdjuster;
eachTrim(): StringArrayAdjuster;
eachOnly(...values: string[]): StringArrayAdjuster;
eachMinLength(length: number): StringArrayAdjuster;
eachMaxLength(length: number, adjust?: boolean /* = false */): StringArrayAdjuster;
eachPattern(pattern: string|RegExp): StringArrayAdjuster;
}
adjust(value[, onError])
Validate and adjust input values.
// should be OK
assert.deepStrictEqual(
adjuster.stringArray().adjust(["a", "b"]),
["a", "b"]);
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().adjust(["a", 1, -2]),
["a", "1", "-2"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust("abc"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.TYPE));
default(value)
Allow undefined
for input, and adjust to value
.
If this method is not called, adjust(undefined)
causes AdjusterError
.
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().default(["a", "b"]).adjust(undefined),
["a", "b"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust(undefined),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));
allowNull([value])
Allow 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.stringArray().allowNull(["a", "b"]).adjust(null),
["a", "b"]);
// should cause error
assert.throws(
() => adjuster.stringArray().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow an empty string(""
) for input, and adjust to value
.
If this method is not called, adjust("")
causes AdjusterError
.
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().allowEmptyString(["a", "b"]).adjust(""),
["a", "b"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().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.
// should be OK
assert.deepStrictEqual(
adjuster.stringArray().separatedBy(",").adjust(["a", "b", "c"]),
["a", "b", "c"]);
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().separatedBy(",").adjust("a,b,c"),
["a", "b", "c"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust("a,b,c"),
(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.stringArray().toArray().adjust(["a"]),
["a"]);
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().toArray().adjust("a"),
["a"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust("a"),
(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.stringArray().minLength(1).adjust(["a"]),
["a"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().minLength(1).adjust([]),
(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.stringArray().maxLength(2).adjust(["a"]),
["a"]);
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().maxLength(1, true).adjust(["a", "b"]),
["a"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().maxLength(1).adjust(["a", "b"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.MAX_LENGTH));
ignoreEachErrors()
Ignore the errors of each element.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().ignoreEachErrors().adjust(["a", "", 1]),
["a", "1"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust(["a", "", 1]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_EMPTY));
eachDefault(value)
Allow undefined
for each elements of input, and adjust to value
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().eachDefault("z").adjust(["a", undefined, "b"]),
["a", "z", "b"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust(["a", undefined, "b"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_REQUIRED));
eachAllowNull([value])
Allow a null
for each elements of input, and adjust to value
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().eachAllowNull("z").adjust(["a", null, "b"]),
["a", "z", "b"]);
// should cause error
assert.throws(
() => adjuster.stringArray().adjust(["a", null, "b"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_NULL));
eachAllowEmptyString([value])
Allow an empty string(""
) for each elements of input, and adjust to value
.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().eachAllowEmptyString("z").adjust(["a", "", "b"]),
["a", "z", "b"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().adjust([""]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_EMPTY));
eachTrim()
Remove whitespace from both ends of each elements of input.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().eachTrim().adjust([" a", "b\t", "\rc\n"]),
["a", "b", "c"]);
eachOnly(...values)
Accept only values
for each elements of input.
examples
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().eachOnly("a", "b").adjust(["a"]),
["a"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().eachOnly("a", "b").adjust(["x"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_ONLY));
eachMinLength(length[, adjust])
Limit minimum string length to length
for each elements of input.
examples
// should be OK
assert.deepStrictEqual(
adjuster.stringArray().eachMinLength(3).adjust(["abc", "xyz"]),
["abc", "xyz"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().eachMinLength(3).adjust(["ab"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_MIN_LENGTH));
eachMaxLength(length[, adjust])
Limit maximum string length to length
for each elements of input.
If the length is greater than length
, it will be adjusted to value
(if adjust
is truthy) or cause AdjusterError
(falsy; default).
examples
// should be OK
assert.deepStrictEqual(
adjuster.stringArray().eachMaxLength(3).adjust(["abc", "xyz"]),
["abc", "xyz"]);
// should be adjusted
assert.deepStrictEqual(
adjuster.stringArray().eachMaxLength(3, true).adjust(["abcd", "xyz0"]),
["abc", "xyz"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().eachMaxLength(3).adjust(["abcd"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_MAX_LENGTH));
eachPattern(pattern)
Specify acceptable pattern for each elements of input by regular expression.
examples
// should be OK
assert.deepStrictEqual(
adjuster.stringArray().eachPattern(/^Go+gle$/).adjust(["Google"]),
["Google"]);
// should cause errors
assert.throws(
() => adjuster.stringArray().eachPattern(/^Go+gle$/).adjust(["Ggle"]),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EACH_PATTERN));
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): NumericStringAdjuster;
allowNull(value?: string|null /* = null */): NumericStringAdjuster;
allowEmptyString(value?: string|null /* = null */): NumericStringAdjuster;
joinArray(): NumericStringAdjuster;
separatedBy(separator: string|RegExp): NumericStringAdjuster;
minLength(length: number): NumericStringAdjuster;
maxLength(length: number, adjust?: boolean /* = false */): NumericStringAdjuster;
checksum(algorithm: string): NumericStringAdjuster;
}
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)
Allow 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));
allowNull([value])
Allow a null
for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.numericString().allowNull("456").adjust(null),
"456");
// should cause error
assert.throws(
() => adjuster.numericString().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow an empty string(""
) for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.numericString().allowEmptyString("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));
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.PATTERN));
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.NUMERIC_STRING_CHECKSUM));
IPv4
ambient declarations
namespace adjuster {
export declare function ipv4(): IPv4Adjuster;
}
interface IPv4Adjuster {
// adjustment method
adjust(value: any, onError?: (err: AdjusterError) => string|void): string;
// feature methods (chainable)
default(value: string): IPv4Adjuster;
allowNull(value?: string|null /* = null */): IPv4Adjuster;
allowEmptyString(value?: string|null /* = null */): IPv4Adjuster;
trim(): IPv4Adjuster;
}
adjust(value[, onError])
Validate and adjust a input value.
examples
// should be OK
assert.strictEqual(
adjuster.ipv4().adjust("0.0.0.0"),
"0.0.0.0");
assert.strictEqual(
adjuster.ipv4().adjust("192.168.0.1"),
"192.168.0.1");
assert.strictEqual(
adjuster.ipv4().adjust("255.255.255.255"),
"255.255.255.255");
// should cause error
assert.throws(
() => adjuster.ipv4().adjust("0.0.0."),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
() => adjuster.ipv4().adjust("0.0.0.0."),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
() => adjuster.ipv4().adjust("255.255.255.256"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
default(value)
Allow undefined
for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.ipv4().default("0.0.0.0").adjust(undefined),
"0.0.0.0");
// should cause error
assert.throws(
() => adjuster.ipv4().adjust(undefined),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));
allowNull([value])
Allow a null
for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.ipv4().allowNull("0.0.0.0").adjust(null),
"0.0.0.0");
// should cause error
assert.throws(
() => adjuster.ipv4().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow an empty string(""
) for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.ipv4().allowEmptyString("0.0.0.0").adjust(""),
"0.0.0.0");
// should cause error
assert.throws(
() => adjuster.ipv4().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.ipv4().trim().adjust("\r\n 1.1.1.1 \t "),
"1.1.1.1");
// should cause error
assert.throws(
() => adjuster.ipv4().trim().adjust(" \t\r\n "),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));
IPv6
ambient declarations
namespace adjuster {
export declare function ipv6(): IPv6Adjuster;
}
interface IPv6Adjuster {
// adjustment method
adjust(value: any, onError?: (err: AdjusterError) => string|void): string;
// feature methods (chainable)
default(value: string): IPv6Adjuster;
allowNull(value?: string|null /* = null */): IPv6Adjuster;
allowEmptyString(value?: string|null /* = null */): IPv6Adjuster;
trim(): IPv6Adjuster;
}
adjust(value[, onError])
Validate and adjust a input value.
examples
// should be OK
assert.strictEqual(
adjuster.ipv6().adjust("0000:0000:0000:0000:0000:0000:0000:0000"),
"0000:0000:0000:0000:0000:0000:0000:0000");
assert.strictEqual(
adjuster.ipv6().adjust("::1"),
"::1");
assert.strictEqual(
adjuster.ipv6().adjust("::"),
"::");
assert.strictEqual(
adjuster.ipv6().adjust("1::1"),
"1::1");
assert.strictEqual(
adjuster.ipv6().adjust("::ffff:192.0.2.1"), // IPv4-mapped address
"::ffff:192.0.2.1");
// should cause error
assert.throws(
() => adjuster.ipv6().adjust("0000"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
() => adjuster.ipv6().adjust("ffff:"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
() => adjuster.ipv6().adjust("0000:0000:0000:0000:0000:0000:0000:0000:"),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
default(value)
Allow undefined
for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.ipv6().default("::").adjust(undefined),
"::");
// should cause error
assert.throws(
() => adjuster.ipv6().adjust(undefined),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.REQUIRED));
allowNull([value])
Allow a null
for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.ipv6().allowNull("::").adjust(null),
"::");
// should cause error
assert.throws(
() => adjuster.ipv6().adjust(null),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.NULL));
allowEmptyString([value])
Allow an empty string(""
) for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.ipv6().allowEmptyString("::").adjust(""),
"::");
// should cause error
assert.throws(
() => adjuster.ipv6().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.ipv6().trim().adjust("\r\n ::1 \t "),
"::1");
// should cause error
assert.throws(
() => adjuster.ipv6().adjust("\r\n ::1 \t "),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.PATTERN));
assert.throws(
() => adjuster.ipv6().trim().adjust(" \t\r\n "),
(err) => (err.name === "AdjusterError" && err.cause === adjuster.CAUSE.EMPTY));
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): EmailAdjuster;
allowNull(value?: string|null /* = null */): EmailAdjuster;
allowEmptyString(value?: string|null /* = null */): EmailAdjuster;
trim(): EmailAdjuster;
pattern(pattern: string|RegExp): EmailAdjuster;
}
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)
Allow 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));
allowNull([value])
Allow a null
for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.email().allowNull("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));
allowEmptyString([value])
Allow an empty string(""
) for input, and adjust to value
.
examples
// should be adjusted
assert.strictEqual(
adjuster.email().allowEmptyString("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"), // allow 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));
Changelog
See CHANGELOG.md.