@pro-script/as-is

v1.3.8

Published

2 months ago

Check your types at runtime with ESNext syntax by meta programing in node.js and browser with interfaces, strict object and more.

Downloads

160

Pro-script Library Documentation

Overview

This library provides a comprehensive framework for type checking, utility functions, and macros for automated testing in JavaScript environments. It offers tools to validate types, manage enumerations, and enhance code quality through structured checks and assertions.

Installation

npm install @pro-script/as-is @pro-script/as-is-plugins

For Browsers

Without module:

<script src="https://www.unpkg.com/@pro-script/as-is"></script>
<script src="https://www.unpkg.com/@pro-script/as-is-plugins/numbers"></script>
<script src="https://www.unpkg.com/@pro-script/as-is-plugins/strings"></script>

With module:

<script type="module">
    import { Checker } from "https://www.unpkg.com/@pro-script/as-is";
    import { NumbersValidator } from "https://www.unpkg.com/@pro-script/as-is-plugins/numbers";
    import { StringsValidator } from "https://www.unpkg.com/@pro-script/as-is-plugins/strings";
    // usage code
</script>

Usage

Node.js (ESM)

import { Checker } from '@pro-script/as-is';
import { NumbersValidator } from '@pro-script/as-is-plugins/numbers';
import { StringsValidator } from '@pro-script/as-is-plugins/strings';

const { as, is, ... } = new Checker({ integrate: Object.assign(NumbersValidator, StringsValidator) });

Node.js (CommonJS)

const { Checker } = require('@pro-script/as-is');
const { NumbersValidator } = require('@pro-script/as-is-plugins/numbers');
const { StringsValidator } = require('@pro-script/as-is-plugins/strings');

const { as, is, ... } = new Checker({ integrate: Object.assign(NumbersValidator, StringsValidator) });

Browser

Without module:

<script>
    const { as, is, ... } = new Checker({ integrate: Object.assign(NumbersValidator, StringsValidator) });
</script>

With module:

<script type="module">
    import { Checker } from "https://www.unpkg.com/@pro-script/as-is";
    import { NumbersValidator } from "https://www.unpkg.com/@pro-script/as-is-plugins/numbers";
    import { StringsValidator } from "https://www.unpkg.com/@pro-script/as-is-plugins/strings";

    const { as, is, ... } = new Checker({ integrate: Object.assign(NumbersValidator, StringsValidator) });
</script>

With import map:

<script type="importmap">
  {
    "imports": {
      "@pro-script/as-is": "https://www.unpkg.com/@pro-script/as-is",
      "@pro-script/as-is-plugins/numbers": "https://www.unpkg.com/@pro-script/as-is-plugins/numbers",
      "@pro-script/as-is-plugins/strings": "https://www.unpkg.com/@pro-script/as-is-plugins/strings",
    }
  }
</script>
<script type="module">
    import { Checker } from '@pro-script/as-is';
    import { NumbersValidator } from '@pro-script/as-is-plugins/numbers';
    import { StringsValidator } from '@pro-script/as-is-plugins/strings';

    const { as, is, ... } = new Checker({ integrate: Object.assign(NumbersValidator, StringsValidator) });
</script>

Summary of Features

Supported Types:

Types list with alias name:

Number | number
String | string
Boolean | boolean
Symbol | symbol
Function | function
BigInt | bigInt | bigint
Array | array
TypedArray | typedArray | Typedarray | typedarray
Buffer | buffer
SharedArrayBuffer | sharedArrayBuffer | SharedarrayBuffer | sharedsrrayBuffer | sharedsrraybuffer
Date | date
Object | date
Class | class
instance
Enum | enum
Set | set
Map | map
Iterator | iterator
Nullish | nullish
WeakSet | weakSet | weeakset
WeakMap | wearMap | weakmap
WeakRef | weakRef | weakref
RegExp | regExp | regexp
Promise | promise
Error | error
RangeError | rangeError
ReferenceError | referenceError
SyntaxError |syntaxError
TypeError | typeError
Any | any

IF/ELSE/END for type checking

    IF.number(string_)? (
        console.log('IF type checking')
    ):ELSE.string(string_)? (
        console.log('ELSE type checking'),
        expect(string_).to.be.eq(string_)
    ):END;

Strict type object:

 strict.string`name`
 strict.name = 'string'
// or
strict.string`name`.name = 'string'

Class checking:

[className]
[classInstance]

is.date(Date);
is.date(new Date);
is.class(Date) or is.class(new Date)

Interface

const { IUser } = Interface({
            IUser: {
                name: as.string,
                age: as.number,
                birthDate: as.date
            }
});
as.IUser = { name: 'Jesus', age: 2022, birthDate: 'Sat Apr 7 0:0:0 GMT+0200 (Central European Summer Time)'};

function example(name, age,  _ = as.IUser = { name, age }) {
            console.log(name, age);
            return 'returned string';
        }

as.StringNumber(example({ name: 'text', age: 12, pages:['page'] }));

Integration

You can integrate any feature you want.

import { Checker, BaseInterface, MicroTest, Utility } from '@pro-script/as-is';
import axios from "axios";

const integrate = {
    up: async function (url) {
        const result = await axios.get(url);
        if(result.status === 200) return 'Ok';
        else throw new TypeError('url is down');
    }
};

const { multi, strict, as, is } = new Checker({ integrate });
const isUrl = as;

async function example(arg, arg2, arg3,
                       type = [as.string(arg), as.number(arg2), as.boolean(arg3)]) {
    await isUrl.up('https://google.com');
    console.log(type);
};

await example('text', 2, true)
// [ 'text', 2, true ]

await isUrl?.up('https://not-google.com');
// TypeError: url is down

Instancing

Minimal set of methods.

const { as, is } = new Checker;

All methods without plugins.

const checker = new Checker({ 'IF/ELSE/END': true, strict: true, Enum: true, utility: true });
const { multi, Interface, as, is, IF, ELSE, END, optional, get, macro, strict, Enum }  = checker;
const { START, STOP, FINISH, METHOD, PROPERTY, IS, CHECK, passed, failed } = new MicroTest({ is, as });

All methods with plugins.

const checker = new Checker({ 
    'IF/ELSE/END': true, 
    strict: true, 
    Enum: true, 
    utility: true, 
    integrate: Object.assign(NumbersValidator, StringsValidator) 
});
const { multi, Interface, as, is, IF, ELSE, END, optional, get, macro, strict, Enum }  = checker;
const { START, STOP, FINISH, METHOD, PROPERTY, IS, CHECK, passed, failed } = new MicroTest({ is, as });

Type Checks

String

is.string(value) -> true | false
as.string(value) -> value | TypeError: [get.type(value)] is not a(an) string

Description:

Checks if the provided argument is a string.

is.string(arg):
- Returns true if arg is a string.
- Returns false otherwise.
as.string(arg):
- Returns arg if it is a string.
- Throws TypeError if

arg is not a string.

Example:

is.string('hello');   // Returns true
is.string(123);       // Returns false

as.string('hello');   // Returns 'hello'
as.string(123);       // Throws TypeError: Number is not a(an) string

Number

is.number(value) -> true | false
as.number(value) -> value | TypeError: [get.type(value)] is not is not a(an) number

Description:

Checks if the provided argument is a number.

is.number(arg):
- Returns true if arg is a number.
- Returns false otherwise.
as.number(arg):
- Returns arg if it is a number.
- Throws TypeError if arg is not a number.

Example:

is.number(123);   // Returns true
is.number('123'); // Returns false

as.number(123);   // Returns 123
as.number('123'); // Throws TypeError: Number is not a(an) number

Boolean

is.boolean(value) -> true | false
as.boolean(value) -> value | TypeError: [get.type(value)] is not a(an) boolean

Description:

Checks if the provided argument is a boolean.

is.boolean(arg):
- Returns true if arg is a boolean.
- Returns false otherwise.
as.boolean(arg):
- Returns arg if it is a boolean.
- Throws TypeError if arg is not a boolean.

Example:

is.boolean(true);  // Returns true
is.boolean(1);     // Returns false

as.boolean(true);  // Returns true
as.boolean(1);     // Throws TypeError: Number is not a(an) boolean

Symbol

is.symbol(value) -> true | false
as.symbol(value) -> value | TypeError: [get.type(value)] is not a(an) symbol

Description:

Checks if the provided argument is a symbol.

is.symbol(arg):
- Returns true if arg is a symbol.
- Returns false otherwise.
as.symbol(arg):
- Returns arg if it is a symbol.
- Throws TypeError if arg is not a symbol.

Example:

const sym = Symbol('test');
is.symbol(sym);        // Returns true
is.symbol('symbol');   // Returns false

as.symbol(sym);        // Returns sym
as.symbol('symbol');   // Throws TypeError: String is not a(an) symbol

Function

is.function(value) -> true | false
as.function(value) -> value | TypeError: [get.type(value)] is not a(an) function

Description:

Checks if the provided argument is a function.

is.function(arg):
- Returns true if arg is a function.
- Returns false otherwise.
as.function(arg):
- Returns arg if it is a function.
- Throws TypeError if arg is not a function.

Example:

const func = () => {};
is.function(func);    // Returns true
is.function(123);     // Returns false

as.function(func);    // Returns func
as.function(123);     // Throws TypeError: Number is not a(an) function

BigInt

is.bigInt(value) -> true | false
as.bigInt(value) -> value | TypeError: [get.type(value)] is not a(an) bigInt

Description:

Checks if the provided argument is a BigInt.

is.bigInt(arg):
- Returns true if arg is a BigInt.
- Returns false otherwise.
as.bigInt(arg):
- Returns arg if it is a BigInt.
- Throws TypeError if arg is not a BigInt.

Example:

const bigIntExample = BigInt('1234567890123456789012345678901234567890');
is.bigInt(bigIntExample);     // Returns true
is.bigInt(1234567890);        // Returns false

as.bigInt(bigIntExample);     // Returns bigIntExample
as.bigInt(1234567890);        // Throws TypeError: Number is not a(an) bigInt

Array

is.array(value) -> true | false
as.array(value) -> value | TypeError: [get.type(value)] is not a(an) bigInt

Description:

Checks if the provided argument is an array.

is.array(arg):
- Returns true if arg is an array.
- Returns false otherwise.
as.array(arg):
- Returns arg if it is an array.
- Throws TypeError if arg is not an array.

Example:

const arrayExample = [];
is.array(arrayExample);    // Returns true
is.array('not an array');  // Returns false

as.array(arrayExample);    // Returns arrayExample
as.array('not an array');  // Throws TypeError: String is not a(an) array

Date

is.date(value) -> true | false
as.date(value) -> value | TypeError: [get.type(value)] is not a(an) date

Description:

Checks if the provided argument is a date.

is.date(arg):
- Returns true if arg is a date.
- Returns false otherwise.
as.date(arg):
- Returns arg if it is a date.
- Throws TypeError if arg is not a date.

Example:

const dateExample = new Date();
is.date(dateExample);    // Returns true
is.date('not a date');   // Returns false

as.date(dateExample);    // Returns dateExample
as.date('not a date');   // Throws TypeError: String is not a(an) date

Object

is.object(value) -> true | false
as.object(value) -> value | TypeError: [get.type(value)] is not a(an) object

Description:

Checks if the provided argument is an object.

is.object(arg):
- Returns true if arg is an object.
- Returns false otherwise.
as.object(arg):
- Returns arg if it is an object.
- Throws TypeError if arg is not an object.

Example:

const objectExample = {};
is.object(objectExample);    // Returns true
is.object('not an object');  // Returns false

as.object(objectExample);    // Returns objectExample
as.object('not an object');  // Throws TypeError: String is not a(an) object

Set

is.set(value) -> true | false
as.set(value) -> value | TypeError: [get.type(value)] is not a(an) set

Description:

Checks if the provided argument is a set.

is.set(arg):
- Returns true if arg is a set.
- Returns false otherwise.
as.set(arg):
- Returns arg if it is a set.
- Throws TypeError if arg is not a set.

Example:

const setExample = new Set();
is.set(setExample);      // Returns true
is.set('not a set');     // Returns false

as.set(setExample);      // Returns setExample
as.set('not a set');     // Throws TypeError: String is not a(an) set

Map

is.map(value) -> true | false
as.map(value) -> value | TypeError: [get.type(value)] is not a(an) map

Description:

Checks if the provided argument is a map.

is.map(arg):
- Returns true if arg is a map.
- Returns false otherwise.
as.map(arg):
- Returns arg if it is a map.
- Throws TypeError if arg is not a map.

Example:

const mapExample = new Map();
is.map(mapExample);      // Returns true
is.map('not a map');     // Returns false

as.map(mapExample);      // Returns mapExample
as.map('not a map');     // Throws TypeError: String is not a(an) map

WeakSet

is.weakSet(value) -> true | false
as.weakSet(value) -> value | TypeError: [get.type(value)] is not a(an) weakSet

Description:

Checks if the provided argument is a WeakSet.

is.weakSet(arg):
- Returns true if arg is a WeakSet.
- Returns false otherwise.
as.weakSet(arg):
- Returns arg if it is a WeakSet.
- Throws TypeError if arg is not a WeakSet.

Example:

const weakSetExample = new WeakSet();
is.weakSet(weakSet

Example);      // Returns true
is.weakSet('not a weakSet');     // Returns false

as.weakSet(weakSetExample);      // Returns weakSetExample
as.weakSet('not a weakSet');     // Throws TypeError: String is not a(an) weakSet

WeakMap

is.weakMap(value) -> true | false
as.weakMap(value) -> value | TypeError: [get.type(value)] is not a(an) weakMap

Description:

Checks if the provided argument is a WeakMap.

is.weakMap(arg):
- Returns true if arg is a WeakMap.
- Returns false otherwise.
as.weakMap(arg):
- Returns arg if it is a WeakMap.
- Throws TypeError if arg is not a WeakMap.

Example:

const weakMapExample = new WeakMap();
is.weakMap(weakMapExample);      // Returns true
is.weakMap('not a weakMap');     // Returns false

as.weakMap(weakMapExample);      // Returns weakMapExample
as.weakMap('not a weakMap');     // Throws TypeError: String is not a(an) weakMap

RegExp

is.regExp(value) -> true | false
as.regExp(value) -> value | TypeError: [get.type(value)] is not a(an) regExp

Description:

Checks if the provided argument is a regular expression.

is.regExp(arg):
- Returns true if arg is a regular expression.
- Returns false otherwise.
as.regExp(arg):
- Returns arg if it is a regular expression.
- Throws TypeError if arg is not a regular expression.

Example:

const regExpExample = /./g;
is.regExp(regExpExample);      // Returns true
is.regExp('not a regExp');     // Returns false

as.regExp(regExpExample);      // Returns regExpExample
as.regExp('not a regExp');     // Throws TypeError: String is not a(an) regExp

Promise

is.promise(value) -> true | false
as.promise(value) -> value | TypeError: [get.type(value)] is not a(an) promise

Description:

Checks if the provided argument is a Promise.

is.promise(arg):
- Returns true if arg is a Promise.
- Returns false otherwise.
as.promise(arg):
- Returns arg if it is a Promise.
- Throws TypeError if arg is not a Promise.

Example:

const promiseExample = new Promise((resolve) => resolve());
is.promise(promiseExample);      // Returns true
is.promise('not a promise');     // Returns false

as.promise(promiseExample);      // Returns promiseExample
as.promise('not a promise');     // Throws TypeError: String is not a(an) promise

Generator

is.generator(value) -> true | false
as.generator(value) -> value | TypeError: [get.type(value)] is not a(an) generator

Description:

Checks if the provided argument is a Generator.

is.generator(arg):
- Returns true if arg is a Generator.
- Returns false otherwise.
as.generator(arg):
- Returns arg if it is a Generator.
- Throws TypeError if arg is not a Generator.

Example:

function* generatorExample() {
    yield 1;
    yield 2;
}
is.generator(generatorExample());     // Returns true
is.generator('not a generator');      // Returns false

as.generator(generatorExample());     // Returns generatorExample
as.generator('not a generator');      // Throws TypeError: String is not a(an) generator

Here is the documentation for the additional type checks:

TypedArray

is.typedArray(value) -> true | false
as.typedArray(value) -> value | TypeError: TypedArray is not a value that passed validation

Description:

Checks if the provided argument is a TypedArray.

is.typedArray(arg):
- Returns true if arg is a TypedArray.
- Returns false otherwise.
as.typedArray(arg):
- Returns arg if it is a TypedArray.
- Throws TypeError if arg is not a TypedArray.

Example:

is.typedArray(new Int8Array());   // Returns true
is.typedArray([]);                // Returns false

as.typedArray(new Int8Array());   // Returns Int8Array
as.typedArray([]);                // Throws TypeError: Array is not a(an) typedArray

Buffer

is.buffer(value) -> true | false
as.buffer(value) -> value | TypeError: [get.type(value)] is not a(an) buffer

Description:

Checks if the provided argument is a Buffer.

is.buffer(arg):
- Returns true if arg is a Buffer.
- Returns false otherwise.
as.buffer(arg):
- Returns arg if it is a Buffer.
- Throws TypeError if arg is not a Buffer.

Example:

is.buffer(Buffer.from('hello'));  // Returns true
is.buffer('hello');               // Returns false

as.buffer(Buffer.from('hello'));  // Returns Buffer
as.buffer('hello');               // Throws TypeError: String is not a(an) buffer

SharedArrayBuffer

is.sharedArrayBuffer(value) -> true | false
as.sharedArrayBuffer(value) -> value | TypeError: [get.type(value)] is not a(an) sharedArrayBuffer

Description:

Checks if the provided argument is a SharedArrayBuffer.

is.sharedArrayBuffer(arg):
- Returns true if arg is a SharedArrayBuffer.
- Returns false otherwise.
as.sharedArrayBuffer(arg):
- Returns arg if it is a SharedArrayBuffer.
- Throws TypeError if arg is not a SharedArrayBuffer.

Example:

is.sharedArrayBuffer(new SharedArrayBuffer());  // Returns true
is.sharedArrayBuffer([]);                       // Returns false

as.sharedArrayBuffer(new SharedArrayBuffer());  // Returns SharedArrayBuffer
as.sharedArrayBuffer([]);                       // Throws TypeError: Array is not a(an) sharedArrayBuffer

Date

is.date(value) -> true | false
as.date(value) -> value | TypeError: [get.type(value)] is not a(an) date

Description:

Checks if the provided argument is a Date object.

is.date(arg):
- Returns true if arg is a Date object.
- Returns false otherwise.
as.date(arg):
- Returns arg if it is a Date object.
- Throws TypeError if arg is not a Date object.

Example:

is.date(new Date());      // Returns true
is.date('2021-01-01');    // Returns false

as.date(new Date());      // Returns Date
as.date('2021-01-01');    // Throws TypeError: String is not a(an) date

Object

is.object(value) -> true | false
as.object(value) -> value | TypeError: [get.type(value)] is not a(an) object

Description:

Checks if the provided argument is an object.

is.object(arg):
- Returns true if arg is an object.
- Returns false otherwise.
as.object(arg):
- Returns arg if it is an object.
- Throws TypeError if arg is not an object.

Example:

is.object({});            // Returns true
is.object('hello');       // Returns false

as.object({});            // Returns {}
as.object('hello');       // Throws TypeError: String is not a(an) object

Class

is.class(value) -> true | false
as.class(value) -> value | TypeError: [get.type(value)] is not a(an) class

Description:

Checks if the provided argument is a class.

is.class(arg):
- Returns true if arg is a class.
- Returns false otherwise.
as.class(arg):
- Returns arg if it is a class.
- Throws TypeError if arg is not a class.

Example:

class MyClass {}
is.class(MyClass);        // Returns true
is.class(() => {});       // Returns false

as.class(MyClass);        // Returns MyClass
as.class(() => {});       // Throws TypeError: Function is not a(an) class

Instance

is.instance(value, constructor) -> true | false
as.instance(value, constructor) -> value | TypeError: [get.type(value)] is not a(an) instance

Description:

Checks if the provided argument is an instance of the specified class.

is.instance(arg, constructor):
- Returns true if arg is an instance of constructor.
- Returns false otherwise.
as.instance(arg, constructor):
- Returns arg if it is an instance of constructor.
- Throws TypeError if arg is not an instance of constructor.

Example:

class MyClass {}
const instance = new MyClass();
is.instance(instance, MyClass);   // Returns true
is.instance({}, MyClass);         // Returns false

as.instance(instance, MyClass);   // Returns instance
as.instance({}, MyClass);         // Throws TypeError: Object is not a(an) instance

Iterator

is.iterator(value) -> true | false
as.iterator(value) -> value | TypeError: [get.type(value)] is not a(an) iterator

Description:

Checks if the provided argument is an iterator.

is.iterator(arg):
- Returns true if arg is an iterator.
- Returns false otherwise.
as.iterator(arg):
- Returns arg if it is an iterator.
- Throws TypeError if arg is not an iterator.

Example:

const iterator = [][Symbol.iterator]();
is.iterator(iterator);    // Returns true
is.iterator([]);          // Returns false

as.iterator(iterator);    // Returns iterator
as.iterator([]);          // Throws TypeError: Array is not a(an) iterator

Nullish

is.nullish(value) -> true | false
as.nullish(value) -> value | TypeError: [get.type(value)] is not a(an) nullish

Description:

Checks if the provided argument is null or undefined.

is.nullish(arg):
- Returns true if arg is null or undefined.
- Returns false otherwise.
as.nullish(arg):
- Returns arg if it is null or undefined.
- Throws TypeError if arg is not null or undefined.

Example:

is.nullish(null);         // Returns true
is.nullish(undefined);    // Returns true
is.nullish('hello');      // Returns false

as.nullish(null);         // Returns null
as.nullish(undefined);    // Returns undefined
as.nullish('hello');      // Throws TypeError: String is not a(an) nullish

Error

is.error(value) -> true | false
as.error(value) -> value | TypeError: [get.type(value)] is not a(an) error

Description:

Checks if the provided argument is an Error.

is.error(arg):
- Returns true if arg is an Error.
- Returns false otherwise.
as.error(arg):
- Returns arg if it is an Error.
- Throws TypeError if arg is not an Error.

Example:

is.error(new Error());    // Returns true
is.error('error');        // Returns false

as.error(new Error());    // Returns Error
as.error('error');        // Throws TypeError: String is not a(an) error

RangeError

is.rangeError(value) -> true | false
as.rangeError(value) -> value | TypeError: [get.type(value)] is not a(an) rangeError

Description:

Checks if the provided argument is a RangeError.

is.rangeError(arg):
- Returns true if arg is a RangeError.
- Returns false otherwise.
as.rangeError(arg):
- Returns arg if it is a RangeError.
- Throws TypeError if arg is not a RangeError.

Example:

is.rangeError(new RangeError());    // Returns true
is.rangeError('error');             // Returns false

as.rangeError(new RangeError());    // Returns RangeError
as.rangeError('error');             // Throws TypeError: String is not a(an) rangeError

ReferenceError

is.referenceError(value) -> true | false
as.referenceError(value) -> value | TypeError: [get.type(value)] is not a(an) referenceError

Description:

Checks if the provided argument is a ReferenceError.

is.referenceError(arg):
- Returns true if arg is a ReferenceError.
- Returns false otherwise.
as.referenceError(arg):
- Returns arg if it is a ReferenceError.
- Throws TypeError if arg is not a ReferenceError.

Example:

is.referenceError(new ReferenceError());    // Returns true
is.referenceError('error');                 // Returns false

as.referenceError(new ReferenceError());    // Returns ReferenceError
as.referenceError('error');                 // Throws TypeError: String is not a(an) referenceError

SyntaxError

is.syntaxError(value) -> true | false
as.syntaxError(value) -> value | TypeError: [get.type(value)] is not a(an) syntaxError

Description:

Checks if the provided argument is a SyntaxError.

is.syntaxError(arg):
- Returns true if arg is a SyntaxError.
- Returns false otherwise.
as.syntaxError(arg):
- Returns arg if it is a SyntaxError.
- Throws TypeError if arg is not a SyntaxError.

Example:

is.syntaxError(new SyntaxError());    // Returns true
is.syntaxError('error');              // Returns false

as.syntaxError(new SyntaxError());    // Returns SyntaxError
as.syntaxError('error');              // Throws TypeError: String is not a(an) syntaxError

TypeError

is.typeError(value) -> true | false
as.typeError(value) -> value | TypeError: [get.type(value)] is not a(an) typeError

Description:

Checks if the provided argument is a TypeError.

is.typeError(arg):
- Returns true if arg is a TypeError.
- Returns false otherwise.
as.typeError(arg):
- Returns arg if it is a TypeError.
- Throws TypeError if arg is not a TypeError.

Example:

is.typeError(new TypeError());    // Returns true
is.typeError('error');            // Returns false

as.typeError(new TypeError());    // Returns TypeError
as.typeError('error');            // Throws TypeError: String is not a(an) typeError

Any

is.any(value) -> true
as.any(value) -> value

Description:

Checks if the provided argument is any value.

is.any(arg):
- Returns true if arg is any value.
- Returns false otherwise.
as.any(arg):
- Returns arg if it is any value.
- Throws TypeError if arg is not any value.

Example:

is.any('hello');    // Returns true
is.any(123);        // Returns true

as.any('hello');    // Returns 'hello'
as.any(123);        // Returns 123

Enum type

Enum type Basic

Enum.init('enum object here')

Enum type Basic usage

Use increment

Enum.init({
    RED: 0,
    GREEN: Enum.inc,
    BLUE: Enum.inc,
});

// Enum {
//   '0': 'RED',
//   '1': 'GREEN',
//   '2': 'BLUE',
//   RED: 0,
//   GREEN: 1,
//   BLUE: 2
// }

Use decrement

Enum.init({
    ROOF: 2,
    FLOOR: Enum.dec,
    BASEMENT: Enum.dec,
});
// Enum {
//   '0': 'BASEMENT',
//   '1': 'FLOOR',
//   '2': 'ROOF',
//   ROOF: 2,
//   FLOOR: 1,
//   BASEMENT: 0
// }

Use both

Enum.init({
    RED: 0,
    GREEN: Enum.inc,
    BLUE: Enum.inc,
    ROOF: 6,
    FLOOR: Enum.dec,
    BASEMENT: Enum.dec,
});
// Enum {
//   '0': 'RED',
//   '1': 'GREEN',
//   '2': 'BLUE',
//   '4': 'BASEMENT',
//   '5': 'FLOOR',
//   '6': 'ROOF',
//   RED: 0,
//   GREEN: 1,
//   BLUE: 2,
//   ROOF: 6,
//   FLOOR: 5,
//   BASEMENT: 4
// }

Use with step

Enum.init({
    [Enum.step]: 10, // ['Enum.step'] the same but with a quotes
    RED: Enum.inc,
    GREEN: Enum.inc,
    BLUE: Enum.inc,
});

// Enum {
//   '10': 'RED',
//   '20': 'GREEN',
//   '30': 'BLUE',
//   RED: 10,
//   GREEN: 20,
//   BLUE: 30
// }
const enumExample = Enum.init({
    [Enum.step]: 10,
    ROOF: Enum.dec,
    FLOOR: 30,
    BASEMENT: Enum.dec,
});
// Enum {
//   '10': 'ROOF',
//   '20': 'BASEMENT',
//   '30': 'FLOOR',
//   ROOF: 10,
//   FLOOR: 30,
//   BASEMENT: 20
// }

Check the Enum type like this

as.Enum(enumExample) && as.enum(enumExample);

Build-in validators

This list of validators works with a minimum set of methods.

Empty

is.empty(value) -> true | false
as.empty(value) -> value | TypeError: Value is not empty

Description:

Checks if the provided argument is empty.

is.empty(arg):
- Returns true if arg is empty.
- Returns false otherwise.
as.empty(arg):
- Returns arg if it is empty.
- Throws TypeError if arg is not empty.

Example:

const emptyArray = [];
is.empty(emptyArray);    // Returns true
is.empty([1, 2, 3]);     // Returns false

as.empty(emptyArray);    // Returns emptyArray
as.empty([1, 2, 3]);     // Throws TypeError: Value is not empty

NotEmpty

is.notEmpty(value) -> true | false
as.notEmpty(value) -> value | TypeError: Value is empty

Description:

Checks if the provided argument is not empty.

is.notEmpty(arg):
- Returns true if arg is not empty.
- Returns false otherwise.
as.notEmpty(arg):
- Returns arg if it is not empty.
- Throws TypeError if arg is empty.

Example:

const notEmptyArray = [1, 2, 3];
is.notEmpty(notEmptyArray);    // Returns true
is.notEmpty([]);               // Returns false

as.notEmpty(notEmptyArray);    // Returns notEmptyArray
as.notEmpty([]);               // Throws TypeError: Value is empty

JSON

is.json(value) -> true | false
as.json(value) -> value | TypeError: Value is not JSON

Description:

Checks if the provided argument is a valid JSON string.

is.json(arg):
- Returns true if arg is a valid JSON string.
- Returns false otherwise.
**

as.json(arg):**

Returns arg if it is a valid JSON string.
Throws TypeError if arg is not a valid JSON string.

Example:

const jsonExample = JSON.stringify({ test: 'test' });
is.json(jsonExample);    // Returns true
is.json('not json');     // Returns false

as.json(jsonExample);    // Returns jsonExample
as.json('not json');     // Throws TypeError: Value is not JSON

JSON5

is.json5(value) -> true | false
as.json5(value) -> value | TypeError: Value is not JSON5

Description:

Checks if the provided argument is a valid JSON5 string.

is.json5(arg):
- Returns true if arg is a valid JSON5 string.
- Returns false otherwise.
as.json5(arg):
- Returns arg if it is a valid JSON5 string.
- Throws TypeError if arg is not a valid JSON5 string.

Example:

const json5Example = '{property: "value"}';
is.json5(json5Example);    // Returns true
is.json5('not json5');     // Returns false

as.json5(json5Example);    // Returns json5Example
as.json5('not json5');     // Throws TypeError: Value is not JSON5

Null

is.null(value) -> true | false
as.null(value) -> value | TypeError: Value is not null

Description:

Checks if the provided argument is null.

is.null(arg):
- Returns true if arg is null.
- Returns false otherwise.
as.null(arg):
- Returns arg if it is null.
- Throws TypeError if arg is not null.

Example:

const nullExample = null;
is.null(nullExample);    // Returns true
is.null('not null');     // Returns false

as.null(nullExample);    // Returns nullExample
as.null('not null');     // Throws TypeError: Value is not null

Number Validators

Sure, I'll restructure the documentation as requested. Here is the first part of the updated documentation:

Zero

is.zero(value) -> true | false
as.zero(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is exactly zero.

is.zero(arg):
- Returns true if arg is 0.
- Returns false otherwise.
as.zero(arg):
- Returns arg if it is 0.
- Throws TypeError if arg is not 0.

Example:

is.zero(0);      // Returns true
is.zero(5);      // Returns false

as.zero(0);      // Returns 0
as.zero(5);      // Throws TypeError: Number is not a value that passed validation

Even

is.even(value) -> true | false
as.even(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is an even number.

is.even(arg):
- Returns true if arg is even.
- Returns false otherwise.
as.even(arg):
- Returns arg if it is even.
- Throws TypeError if arg is not even.

Example:

is.even(2);      // Returns true
is.even(3);      // Returns false

as.even(2);      // Returns 2
as.even(3);      // Throws TypeError: Number is not a value that passed validation

Odd

is.odd(value) -> true | false
as.odd(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is an odd number.

is.odd(arg):
- Returns true if arg is odd.
- Returns false otherwise.
as.odd(arg):
- Returns arg if it is odd.
- Throws TypeError if arg is not odd.

Example:

is.odd(1);      // Returns true
is.odd(4);      // Returns false

as.odd(1);      // Returns 1
as.odd(4);      // Throws TypeError: Number is not a value that passed validation

Positive

is.positive(value) -> true | false
as.positive(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a positive number.

is.positive(arg):
- Returns true if arg is positive.
- Returns false otherwise.
as.positive(arg):
- Returns arg if it is positive.
- Throws TypeError if arg is not positive.

Example:

is.positive(1.1);      // Returns true
is.positive(-1.1);     // Returns false

as.positive(1.1);      // Returns 1.1
as.positive(-1.1);     // Throws TypeError: Number is not a value that passed validation

Negative

is.negative(value) -> true | false
as.negative(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a negative number.

is.negative(arg):
- Returns true if arg is negative.
- Returns false otherwise.
as.negative(arg):
- Returns arg if it is negative.
- Throws TypeError if arg is not negative.

Example:

is.negative(-1.1);      // Returns true
is.negative(1.1);       // Returns false

as.negative(-1.1);      // Returns -1.1
as.negative(1.1);       // Throws TypeError: Number is not a value that passed validation

Positive Integer

is.positiveInteger(value) -> true | false
as.positiveInteger(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a positive integer.

is.positiveInteger(arg):
- Returns true if arg is a positive integer.
- Returns false otherwise.
as.positiveInteger(arg):
- Returns arg if it is a positive integer.
- Throws TypeError if arg is not a positive integer.

Example:

is.positiveInteger(1);      // Returns true
is.positiveInteger(-1);     // Returns false

as.positiveInteger(1);      // Returns 1
as.positiveInteger(-1);     // Throws TypeError: Number is not a value that passed validation

Negative Integer

is.negativeInteger(value) -> true | false
as.negativeInteger(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a negative integer.

is.negativeInteger(arg):
- Returns true if arg is a negative integer.
- Returns false otherwise.
as.negativeInteger(arg):
- Returns arg if it is a negative integer.
- Throws TypeError if arg is not a negative integer.

Example:

is.negativeInteger(-1);      // Returns true
is.negativeInteger(1);       // Returns false

as.negativeInteger(-1);      // Returns -1
as.negativeInteger(1);       // Throws TypeError: Number is not a value that passed validation

Finite

is.isFinite(value) -> true | false
as.isFinite(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a finite number.

is.isFinite(arg):
- Returns true if arg is finite.
- Returns false otherwise.
as.isFinite(arg):
- Returns arg if it is finite.
- Throws TypeError if arg is not finite.

Example:

is.isFinite(0);      // Returns true
is.isFinite(Infinity); // Returns false

as.isFinite(0);      // Returns 0
as.isFinite(Infinity); // Throws TypeError: Number is not a value that passed validation

NaN

is.NaN(value) -> true | false
as.NaN(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is NaN (Not-a-Number).

is.NaN(arg):
- Returns true if arg is NaN.
- Returns false otherwise.
as.NaN(arg):
- Returns arg if it is NaN.
- Throws TypeError if arg is not NaN.

Example:

is.NaN(NaN);      // Returns true
is.NaN(0);        // Returns false

as.NaN(NaN);      // Returns NaN
as.NaN(0);        // Throws TypeError: Number is not a value that passed validation

Between

is.between({ arg, min, max }) -> true | false
as.between({ arg, min, max }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is between min and max values.

is.between({ arg, min, max }):
- Returns true if arg is between min and max.
- Returns false otherwise.
as.between({ arg, min, max }):
- Returns arg if it is between min and max.
- Throws TypeError if arg is not between min and max.

Example:

is.between({ arg: 5, min: 0, max: 10 });  // Returns true
is.between({ arg: 15, min: 0, max: 10 }); // Returns false

as.between({ arg: 5, min: 0, max: 10 });  // Returns 5
as.between({ arg: 15, min: 0, max: 10 }); // Throws TypeError: Number is not a value that passed validation

Greater

is.greater({ arg, value }) -> true | false
as.greater({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is greater than the specified value.

is.greater({ arg, value }):
- Returns true if arg is greater than value.
- Returns `

false` otherwise.

as.greater({ arg, value }):
- Returns arg if it is greater than value.
- Throws TypeError if arg is not greater than value.

Example:

is.greater({ arg: 15, value: 5 });  // Returns true
is.greater({ arg: 5, value: 15 });  // Returns false

as.greater({ arg: 15, value: 5 });  // Returns 15
as.greater({ arg: 5, value: 15 });  // Throws TypeError: Number is not a value that passed validation

Less

is.less({ arg, value }) -> true | false
as.less({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is less than the specified value.

is.less({ arg, value }):
- Returns true if arg is less than value.
- Returns false otherwise.
as.less({ arg, value }):
- Returns arg if it is less than value.
- Throws TypeError if arg is not less than value.

Example:

is.less({ arg: 5, value: 15 });  // Returns true
is.less({ arg: 15, value: 5 });  // Returns false

as.less({ arg: 5, value: 15 });  // Returns 5
as.less({ arg: 15, value: 5 });  // Throws TypeError: Number is not a value that passed validation

Equal or Greater

is.equalGreater({ arg, value }) -> true | false
as.equalGreater({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is equal to or greater than the specified value.

is.equalGreater({ arg, value }):
- Returns true if arg is equal to or greater than value.
- Returns false otherwise.
as.equalGreater({ arg, value }):
- Returns arg if it is equal to or greater than value.
- Throws TypeError if arg is not equal to or greater than value.

Example:

is.equalGreater({ arg: 5, value: 5 });  // Returns true
is.equalGreater({ arg: 4, value: 5 });  // Returns false

as.equalGreater({ arg: 5, value: 5 });  // Returns 5
as.equalGreater({ arg: 4, value: 5 });  // Throws TypeError: Number is not a value that passed validation

Equal or Less

is.equalLess({ arg, value }) -> true | false
as.equalLess({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is equal to or less than the specified value.

is.equalLess({ arg, value }):
- Returns true if arg is equal to or less than value.
- Returns false otherwise.
as.equalLess({ arg, value }):
- Returns arg if it is equal to or less than value.
- Throws TypeError if arg is not equal to or less than value.

Example:

is.equalLess({ arg: 5, value: 5 });  // Returns true
is.equalLess({ arg: 6, value: 5 });  // Returns false

as.equalLess({ arg: 5, value: 5 });  // Returns 5
as.equalLess({ arg: 6, value: 5 });  // Throws TypeError: Number is not a value that passed validation

Max

is.max({ arg, value }) -> true | false
as.max({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is equal to the specified maximum value.

is.max({ arg, value }):
- Returns true if arg is equal to the maximum value.
- Returns false otherwise.
as.max({ arg, value }):
- Returns arg if it is equal to the maximum value.
- Throws TypeError if arg is not equal to the maximum value.

Example:

is.max({ arg: 5, value: 5 });  // Returns true
is.max({ arg: 4, value: 5 });  // Returns false

as.max({ arg: 5, value: 5 });  // Returns 5
as.max({ arg: 4, value: 5 });  // Throws TypeError: Number is not a value that passed validation

Min

is.min({ arg, value }) -> true | false
as.min({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is equal to the specified minimum value.

is.min({ arg, value }):
- Returns true if arg is equal to the minimum value.
- Returns false otherwise.
as.min({ arg, value }):
- Returns arg if it is equal to the minimum value.
- Throws TypeError if arg is not equal to the minimum value.

Example:

is.min({ arg: 5, value: 5 });  // Returns true
is.min({ arg: 6, value: 5 });  // Returns false

as.min({ arg: 5, value: 5 });  // Returns 5
as.min({ arg: 6, value: 5 });  // Throws TypeError: Number is not a value that passed validation

Multiple

is.multiple({ arg, value }) -> true | false
as.multiple({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a multiple of the specified value.

is.multiple({ arg, value }):
- Returns true if arg is a multiple of value.
- Returns false otherwise.
as.multiple({ arg, value }):
- Returns arg if it is a multiple of value.
- Throws TypeError if arg is not a multiple of value.

Example:

is.multiple({ arg: 15, value: 5 });  // Returns true
is.multiple({ arg: 14, value: 5 });  // Returns false

as.multiple({ arg: 15, value: 5 });  // Returns 15
as.multiple({ arg: 14, value: 5 });  // Throws TypeError: Number is not a value that passed validation

Port

is.port(value) -> true | false
as.port(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid port number (between 0 and 65535).

is.port(arg):
- Returns true if arg is a valid port number.
- Returns false otherwise.
as.port(arg):
- Returns arg if it is a valid port number.
- Throws TypeError if arg is not a valid port number.

Example:

is.port(80);      // Returns true
is.port(70000);   // Returns false

as.port(80);      // Returns 80
as.port(70000);   // Throws TypeError: Number is not a value that passed validation

Safe Integer

is.safe(value) -> true | false
as.safe(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a safe integer (within the range of Number.MIN_SAFE_INTEGER and Number.MAX_SAFE_INTEGER).

is.safe(arg):
- Returns true if arg is a safe integer.
- Returns false otherwise.
as.safe(arg):
- Returns arg if it is a safe integer.
- Throws TypeError if arg is not a safe integer.

Example:

is.safe(Number.MAX_SAFE_INTEGER);      // Returns true
is.safe(Number.MAX_SAFE_INTEGER + 1);  // Returns false

as.safe(Number.MAX_SAFE_INTEGER);      // Returns Number.MAX_SAFE_INTEGER
as.safe(Number.MAX_SAFE_INTEGER + 1);  // Throws TypeError: Number is not a value that passed validation

Precision

is.precision({ arg, value }) -> true | false
as.precision({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument has the specified precision value.

is.precision({ arg, value }):
- Returns `true

ifarghas the specified precisionvalue`.

Returns false otherwise.
as.precision({ arg, value }):
- Returns arg if it has the specified precision value.
- Throws TypeError if arg does not have the specified precision value.

Example:

is.precision({ arg: 5.22, value: 2 });  // Returns true
is.precision({ arg: 5.2, value: 2 });   // Returns false

as.precision({ arg: 5.22, value: 2 });  // Returns 5.22
as.precision({ arg: 5.2, value: 2 });   // Throws TypeError: Number is not a value that passed validation

Digits

is.digits({ arg, value }) -> true | false
as.digits({ arg, value }) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument has the specified number of digits value.

is.digits({ arg, value }):
- Returns true if arg has the specified number of digits value.
- Returns false otherwise.
as.digits({ arg, value }):
- Returns arg if it has the specified number of digits value.
- Throws TypeError if arg does not have the specified number of digits value.

Example:

is.digits({ arg: 12345, value: 5 });  // Returns true
is.digits({ arg: 1234, value: 5 });   // Returns false

as.digits({ arg: 12345, value: 5 });  // Returns 12345
as.digits({ arg: 1234, value: 5 });   // Throws TypeError: Number is not a value that passed validation

ISBN-10

is.ISBN10(value) -> true | false
as.ISBN10(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid ISBN-10 number.

is.ISBN10(arg):
- Returns true if arg is a valid ISBN-10 number.
- Returns false otherwise.
as.ISBN10(arg):
- Returns arg if it is a valid ISBN-10 number.
- Throws TypeError if arg is not a valid ISBN-10 number.

Example:

is.ISBN10(1234567890);  // Returns true
is.ISBN10(123456789);   // Returns false

as.ISBN10(1234567890);  // Returns 1234567890
as.ISBN10(123456789);   // Throws TypeError: Number is not a value that passed validation

ISBN-13

is.ISBN13(value) -> true | false
as.ISBN13(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid ISBN-13 number.

is.ISBN13(arg):
- Returns true if arg is a valid ISBN-13 number.
- Returns false otherwise.
as.ISBN13(arg):
- Returns arg if it is a valid ISBN-13 number.
- Throws TypeError if arg is not a valid ISBN-13 number.

Example:

is.ISBN13(1234567890123);  // Returns true
is.ISBN13(123456789012);   // Returns false

as.ISBN13(1234567890123);  // Returns 1234567890123
as.ISBN13(123456789012);   // Throws TypeError: Number is not a value that passed validation

EAN

is.EAN(value) -> true | false
as.EAN(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid EAN (European Article Number).

is.EAN(arg):
- Returns true if arg is a valid EAN.
- Returns false otherwise.
as.EAN(arg):
- Returns arg if it is a valid EAN.
- Throws TypeError if arg is not a valid EAN.

Example:

is.EAN(1234567890123);  // Returns true
is.EAN(123456789012);   // Returns false

as.EAN(1234567890123);  // Returns 1234567890123
as.EAN(123456789012);   // Throws TypeError: Number is not a value that passed validation

SSN

is.SSN(value) -> true | false
as.SSN(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid SSN (Social Security Number).

is.SSN(arg):
- Returns true if arg is a valid SSN.
- Returns false otherwise.
as.SSN(arg):
- Returns arg if it is a valid SSN.
- Throws TypeError if arg is not a valid SSN.

Example:

is.SSN(123456789);  // Returns true
is.SSN(12345678);   // Returns false

as.SSN(123456789);  // Returns 123456789
as.SSN(12345678);   // Throws TypeError: Number is not a value that passed validation

VIN

is.VIN(value) -> true | false
as.VIN(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid VIN (Vehicle Identification Number).

is.VIN(arg):
- Returns true if arg is a valid VIN.
- Returns false otherwise.
as.VIN(arg):
- Returns arg if it is a valid VIN.
- Throws TypeError if arg is not a valid VIN.

Example:

is.VIN(12345678901234567);  // Returns true
is.VIN(1234567890123456);   // Returns false

as.VIN(12345678901234567);  // Returns 12345678901234567
as.VIN(1234567890123456);   // Throws TypeError: Number is not a value that passed validation

INN-10

is.INN10(value) -> true | false
as.INN10(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid INN (Individual Taxpayer Number) with 10 digits.

is.INN10(arg):
- Returns true if arg is a valid INN with 10 digits.
- Returns false otherwise.
as.INN10(arg):
- Returns arg if it is a valid INN with 10 digits.
- Throws TypeError if arg is not a valid INN with 10 digits.

Example:

is.INN10(1234567890);  // Returns true
is.INN10(123456789);   // Returns false

as.INN10(1234567890);  // Returns 1234567890
as.INN10(123456789);   // Throws TypeError: Number is not a value that passed validation

INN-12

is.INN12(value) -> true | false
as.INN12(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid INN (Individual Taxpayer Number) with 12 digits.

is.INN12(arg):
- Returns true if arg is a valid INN with 12 digits.
- Returns false otherwise.
as.INN12(arg):
- Returns arg if it is a valid INN with 12 digits.
- Throws TypeError if arg is not a valid INN with 12 digits.

Example:

is.INN12(123456789012);  // Returns true
is.INN12(12345678901);   // Returns false

as.INN12(123456789012);  // Returns 123456789012
as.INN12(12345678901);   // Throws TypeError: Number is not a value that passed validation

GLN

is.GLN(value) -> true | false
as.GLN(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid GLN (Global Location Number).

is.GLN(arg):
- Returns true if arg is

a valid GLN.

Returns false otherwise.
as.GLN(arg):
- Returns arg if it is a valid GLN.
- Throws TypeError if arg is not a valid GLN.

Example:

is.GLN(1234567890123);  // Returns true
is.GLN(123456789012);   // Returns false

as.GLN(1234567890123);  // Returns 1234567890123
as.GLN(123456789012);   // Throws TypeError: Number is not a value that passed validation

IMEI

is.IMEI(value) -> true | false
as.IMEI(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid IMEI (International Mobile Equipment Identity).

is.IMEI(arg):
- Returns true if arg is a valid IMEI.
- Returns false otherwise.
as.IMEI(arg):
- Returns arg if it is a valid IMEI.
- Throws TypeError if arg is not a valid IMEI.

Example:

is.IMEI(123456789012345);  // Returns true
is.IMEI(12345678901234);   // Returns false

as.IMEI(123456789012345);  // Returns 123456789012345
as.IMEI(12345678901234);   // Throws TypeError: Number is not a value that passed validation

NPI

is.NPI(value) -> true | false
as.NPI(value) -> value | TypeError: Number is not a value that passed validation

Description:

Checks if the provided argument is a valid NPI (National Provider Identifier).

is.NPI(arg):
- Returns true if arg is a valid NPI.
- Returns false otherwise.
as.NPI(arg):
- Returns arg if it is a valid NPI.
- Throws TypeError if arg is not a valid NPI.

Example:

is.NPI(1234567890);  // Returns true
is.NPI(123456789);   // Returns false

as.NPI(1234567890);  // Returns 1234567890
as.NPI(123456789);   // Throws TypeError: Number is not a value that passed validation

String Validators

Here is the restructured documentation for the string validation methods:

Alphabetic

is.alphabetic(value) -> true | false
as.alphabetic(value) -> value | TypeError: String is not alphabetic

Description:

Checks if the provided argument is an alphabetic string.

is.alphabetic(arg):
- Returns true if arg contains only alphabetic characters.
- Returns false otherwise.
as.alphabetic(arg):
- Returns arg if it contains only alphabetic characters.
- Throws TypeError if arg does not contain only alphabetic characters.

Example:

is.alphabetic('hello');  // Returns true
is.alphabetic('hello123');  // Returns false

as.alphabetic('hello');  // Returns 'hello'
as.alphabetic('hello123');  // Throws TypeError: String is not alphabetic

Digit

is.digit(value) -> true | false
as.digit(value) -> value | TypeError: String is not digit

Description:

Checks if the provided argument is an digit string.

is.digit(arg):
- Returns true if arg contains only digit characters.
- Returns false otherwise.
as.digit(arg):
- Returns arg if it contains only digit characters.
- Throws TypeError if arg does not contain only digit characters.

Example:

is.digit('123');  // Returns true
is.digit('hello123');  // Returns false

as.digit('123');  // Returns '123'
as.digit('hello123');  // Throws TypeError: String is not digit

Lowercase

is.lowercase(value) -> true | false
as.lowercase(value) -> value | TypeError: String is not lowercase

Description:

Checks if the provided argument is a lowercase string.

is.lowercase(arg):
- Returns true if arg is a lowercase string.
- Returns false otherwise.
as.lowercase(arg):
- Returns arg if it is a lowercase string.
- Throws TypeError if arg is not a lowercase string.

Example:

is.lowercase('hello');  // Returns true
is.lowercase('Hello');  // Returns false

as.lowercase('hello');  // Returns 'hello'
as.lowercase('Hello');  // Throws TypeError: String is not lowercase

Uppercase

is.uppercase(value) -> true | false
as.uppercase(value) -> value | TypeError: String is not uppercase

Description:

Checks if the provided argument is an uppercase string.

is.uppercase(arg):
- Returns true if arg is an uppercase string.
- Returns false otherwise.
as.uppercase(arg):
- Returns arg if it is an uppercase string.
- Throws TypeError if arg is not an uppercase string.

Example:

is.uppercase('HELLO');  // Returns true
is.uppercase('Hello');  // Returns false

as.uppercase('HELLO');  // Returns 'HELLO'
as.uppercase('Hello');  // Throws TypeError: String is not uppercase

CamelCase

is.camelCase(value) -> true | false
as.camelCase(value) -> value | TypeError: String is not camelCase

Description:

Checks if the provided argument is a camelCase string.

is.camelCase(arg):
- Returns true if arg is a camelCase string.
- Returns false otherwise.
as.camelCase(arg):
- Returns arg if it is a camelCase string.
- Throws TypeError if arg is not a camelCase string.

Example:

is.camelCase('camelCase');  // Returns true
is.camelCase('CamelCase');  // Returns false

as.camelCase('camelCase');  // Returns 'camelCase'
as.camelCase('CamelCase');  // Throws TypeError: String is not camelCase

snakeCase

is.snakeCase(value) -> true | false
as.snakeCase(value) -> value | TypeError: String is not snakeCase

Description:

Checks if the provided argument is a snakeCase string.

is.snakeCase(arg):
- Returns true if arg is a snakeCase string.
- Returns false otherwise.
as.snakeCase(arg):
- Returns arg if it is a snakeCase string.
- Throws TypeError if arg is not a snakeCase string.

Example:

is.snakeCase('snakeCase');  // Returns true
is.snakeCase('SnakeCase');   // Returns false

as.snakeCase('snakeCase');  // Returns 'snakeCase'
as.snakeCase('SnakeCase');   // Throws TypeError: String is not snakeCase

Kebab-Case

is.kebabCase(value) -> true | false
as.kebabCase(value) -> value | TypeError: String is not kebab-c

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Pro-script Library Documentation

Overview

Table of Contents

Installation

For Browsers

Usage

Node.js (ESM)

Node.js (CommonJS)

Browser

Summary of Features

Supported Types:

Integration

Instancing

Type Checks

String

Number

Boolean

Symbol

Function

BigInt

Array

Date

Object

Set

Map

WeakSet

WeakMap

RegExp

Promise

Generator

TypedArray

Buffer

SharedArrayBuffer

Date

Object

Class

Instance

Iterator

Nullish

Error

RangeError

ReferenceError

SyntaxError

TypeError

Any

Enum type

Enum type Basic

Enum type Basic usage

Build-in validators

Empty

NotEmpty

JSON

JSON5

Null

Number Validators

Zero

Even

Odd

Positive

Negative

Positive Integer

Negative Integer

Finite

NaN

Between

Greater

Less

Equal or Greater

Equal or Less

Max

Min

Multiple

Port

Safe Integer