TypeArray
Status
Table of Content
Purpose
TypeArray class definition
Installation
Via npm
npm install @scuba-squad/type-array
API
TypeArray(validator: function | string | RegExp | Array, message?: string | null)
Added in: v1.0.0
Factory method to get a function to create a Typed|Validated Array
arguments:
validator: function | string | RegExp | Array
message: string | null = 'invalid value'
returns: Function
throws: TypeError
const TypeArray = ;const NumberArray = ;const test = ;console; // 3console; // 1test; // 4console; // 0test; // 3console; // 5.4test; // TypeError: invalid value
const TypeArray = ;const NumberArray = ;const test = ;console; // 3console; // 1test; // 4console; // 0test; // 3console; // 5.4test; // 4 (value is castable to float so passes isFloat validation)test; // TypeError: invalid value
const TypeArray = ;const NumberArray = ;const test = ;console; // 3console; // 1test; // 4console; // 0test; // 3console; // 5.4test; // 4 (value passes validation)test; // TypeError: invalid value
const TypeArray = ;const NumberArray = ;const test = ;console; // 3console; // 1test; // 4console; // 0test; // 3console; // 5.4test; // 4 (value is castable to float so passes isFloat validation)test; // TypeError: invalid value
TypeArray.ErrorArray(...args: Error)
Added in: v1.0.0
Function to create a predefined ErrorArray
arguments:
...args: Error
returns: Array
throws: TypeError
const ErrorArray = ;const test = ;console; // 1console; // Error: atest;console; // TypeError: invalidtest; // TypeError: value must be an Error
TypeArray.FunctionArray(...args: Function)
Added in: v1.0.0
Function to create a predefined FunctionArray
arguments:
...args: Function
returns: Array
throws: TypeError
const FunctionArray = ;const test = ;console; // 1console; // [Function: Number]test;console; // [Function]test; // TypeError: value must be a Function
TypeArray.PromiseArray(...args: Promise)
Added in: v1.0.0
Function to create a predefined PromiseArray
arguments:
...args: Promise
returns: Array
throws: TypeError
const PromiseArray = ;const test = ;console; // 1console; // Promise { 5 }test;console; // Promise { <rejected> 'fail' }test; // TypeError: value must be a Promise
Test
npm installnpm test