@toreda/chk

@toreda/chk - Pronounced Check [ chek ]

Eliminate more edge cases with less code. Automates common type checks and validation checks.

 

Checks

chkArray

Check that value is a valid array.

chkArrayEmpty

Check that value is a valid array and empty.

chkBigInt

Check that value is a BigInt type, is an integer, and is finite.

chkBoolean

Check that value has a boolean value true or false. Does not use type coercion.

chkStringId

Configurable validator for string-based ID values. Accepts a number of boundary condition parameters including min/max length, allow empty, allow nulls, auto-trim, etc.

chkUrl

Configurable validator for URL values.

 

Rule Validators

Rule validators check for a single condition using one or more function arguments and return a strict boolean value true or false.

Maths

powOf

Determine if value is a power of exponent.

 

Useful validating:

• User uploaded image dimensions.
• Texture sizes with size requirements, e.g. the power of 2 rule.
• Cases where inputs may have non-number or non-finite values.
• Performs type and bound checks on values before attempting to use math functions and returns false if the call would otherwise fail.

 

// Determine if 0 is a power of 1.
const result = powOf(0, 1);

// Determine if 100 is a power of 10.
const result = powOf(100, 10);

 

---

 

Collections

isArrayEmpty

Determine if value is an array and if so, whether it's empty. Does not throw. Returns false in all cases where value is not an array.

 

Useful when:

• value is not an array or may not be an array.

 

const value: string[] = [];

// Result is TRUE.
const result = isArrayEmpty(value);

const value: string[] = ['one'];

// Result is FALSE.
const result = isArrayEmpty(value);

const value = 'one';

// Result is FALSE.
const result = isArrayEmpty(value);

// Result is FALSE.
const result = isArrayEmpty(null);

// Result is FALSE.
const result = isArrayEmpty({});

TypeScript Equivalent

const value: unknown = '081408';
const result = Array.isArray(value) && value.length === 0;

 

Install

@toreda/chk is available as an NPM package.

 

Install with yarn:

yarn add @toreda/chk

or Install with NPM:

npm install @toreda/chk

 

Source Code

@toreda/chk is an open source package provided under the MIT License. Download, clone, or check the complete project source here on Github. We welcome bug reports, comments, and pull requests.

 

Legal

License

MIT © Toreda, Inc.

Copyright

Copyright © 2023 Toreda, Inc. All Rights Reserved.

 

Github

https://github.com/toreda

Website

https://www.toreda.com