Hello! My Name is Martin Thuku. I make software!
instance props
+indexes getter
indexes setter
text getter
value getter
value setter
Static CHARSAlphabet characters
+Static parseParse value to AlphaNum instance
number ~ integers (e.g. 1999 => 'BXX'; -1999 => '-BXX')text /-?[A-Z]+/ (e.g. 'BXX' => 1999; '-BXX' => -1999)array (e.g. [1,23,23] => 'BXX'|1999; [-1,1,23,23] => '-BXX'|-1999)parse value (see method docs for acceptable values)
+AlphaNum instance
TypeError on failure
Static textGenerated using TypeDoc
New instance
+Get tracking data (this will stop tracking)
+Track current time (sets this._ms to time difference between last start and now)
+Set start to now
+Start time tracking (sets start_time to now and resets other properties)
+Stop time tracking (sets this._ms to time difference between last start and last stop) +If last stop is less than start time, stop time is updated to now.
+Generated using TypeDoc
Create new instance
+Instance "private" props
+Max listeners count (default: undefiend ~ EventEmitter.max_listeners)
numberStatic max_EventEmitter global max listeners
+Add event listener ~ emits 'newListener' event if added
+event type/name
+event listener callback function
+one time callback
+EventEmitter - this instance
Check if event listener exists
+event type/name
+event listener
+((event:IEvent)=>void)[] event handlers
Add event listener ~ emits 'newListener' event if added (alias emitter.addListener)
event type/name
+event listener callback function
+one time callback
+EventEmitter - this instance
Add one time event listener ~ emits 'newListener' event if added
+event type/name
+event listener callback function
+EventEmitter - this instance
Remove all listeners ~ emits 'removeListener' event for each removed listener
+event type/name
+EventEmitter - this instance
Remove event listener ~ emits 'removeListener' event if removed
+event type/name
+event listener callback function
+EventEmitter - this instance
Add event subscriber
+event type/name
+event callback handler
+(()=>void) unsubscribe callback
Add event subscriber
+(()=>void) unsubscribe callback
Static listenerGet valid event listener callback function.
+event listener
+enable throwing error when listener is invalid
+(event:IEvent)=>void event handler | undefined on error
Static typeGenerated using TypeDoc
Exception extends Error ~ like DOMException
stringstringnumber()=>stringNew IExceptionError instance
Optional message: stringerror message (default: 'Unspecified exception message.')
Optional name: stringerror name (default: 'Exception')
Optional code: string | numbererror code - string | finite/parsed integer (default: 0)
Optional data: anyerror data
+Optional time: numbererror timestamp milliseconds (default: Date.now())
IExceptionError
Private props
+Optional causeOptional stackStatic Optional prepareOptional override for formatting stack traces
+Static stackError code - string | finite/parsed integer (default: 0)
Error data
+Error message (default: 'Unspecified exception message.')
Error name (default: 'Exception')
Error data
+Static captureStatic errorCreate new Exception
Optional message: stringerror message (default: 'Unspecified exception message.')
Optional name: stringerror name (default: 'Exception')
Optional code: string | numbererror code - string | finite/parsed integer (default: 0)
Optional data: anyerror data
+Optional time: numbererror timestamp milliseconds (default: Date.now())
IExceptionError
Static parseCreate new Exception from parsed error
Optional error: anyparse error value (i.e. string message or Error/object/values {message: string, name: string|undefined, code: string|number|undefined, data: any, time: number ?? Date.now()})
IExceptionError
Generated using TypeDoc
Failure error instance/handler
+parse error message
+error mode ~ 0 = silent (default) | 1 = logs warning | 2 = logs error | 3 = throws error
error debug
+Optional name: stringerror name
+Optional causeOptional stackStatic Optional prepareOptional override for formatting stack traces
+Static stackStatic captureGenerated using TypeDoc
Optional causeOptional stackStatic Optional prepareOptional override for formatting stack traces
+Static stackStatic captureGenerated using TypeDoc
Create new instance
+task name
+task value/total/progress linked ~ recalculate on change
+decimal places (default: Task.decimal_precision)
event debounce milliseconds (default: Task.event_debounce)
Instance "private" props
+Task complete
+Task elapsedTime - millisecond timestamps difference (i.e. stopTime - startTime)
Task error
+Task event debounce milliseconds (default: Tasks.event_debounce)
Task item
+Task label
+Task linked - value/total/progress (recalculate on change)
+Task name
+Task precision - integer decimal places
Task progress
+Task startTime - timestamp milliseconds (i.e. Date.now())
Task stopTime - timestamp milliseconds (i.e. Date.now())
Task total
+Task value
+Static decimal_Task global precision ~ round decimal places
+Static event_Task global event debounce milliseconds
+Set progress
+task percentage progress (0-100)
Optional _value: numberunlinked task value update ~ ignores undefined
Optional _total: numberunlinked task total update ~ ignores undefined
Task instance
Add update event subscriber ~ event = {type: 'update', data: ITask}
event callback listener
+(()=>void) unsubscribe callback
Add update event subscriber ~ event = {type: 'update', data: ITask}
(()=>void) unsubscribe callback
Static createCreate instance from existing task options
+ITask options ~ i.e. {name, label, linked, precision, event_debounce, progress, total, value, error, status, startTime, stopTime, complete, item}
Optional precision: numberdecimal places (default: Task.decimal_precision)
Optional event_debounce: numberevent debounce milliseconds (default: Task.event_debounce)
Task instance
validation Error
Generated using TypeDoc
Create new instance
+decimal places (default: Tasks.decimal_precision)
event debounce milliseconds (default: Tasks.event_debounce)
Instance "private" props
+Get tasks data
+ITasksData options ~ i.e. {precision, event_debounce, size, progress, running, started, complete, startTime, stopTime, elapsedTime, tasks}
Get tasks data
+ITasksData options ~ i.e. {precision, event_debounce, size, progress, running, started, complete, startTime, stopTime, elapsedTime, tasks}
Task event debounce milliseconds (default: Tasks.event_debounce)
Task precision - integer decimal places
Tasks count
+Static decimal_Task global precision ~ round decimal places
+Static event_Tasks global event debounce milliseconds
+Add update event subscriber ~ event = {type: 'update', data: ITask}
event callback listener
+(()=>void) unsubscribe callback
Add update event subscriber ~ event = {type: 'update', data: ITask}
(()=>void) unsubscribe callback
Generated using TypeDoc
Term console.* logger
Static FORMATSText formats
+Static FORMAT_Format disabled
+Static LOG_Preferred console log method
+Static LOG_Console log methods
+Static PREDEFINED_Predefined text formats
+Static clearConsole clear logs
+Console clear logs
+Static brStatic cleanStatic debugStatic errorStatic formatFormat text items
+text formats
+Rest ...args: any[]parse items (arguments)
+ITermFormat
Static getStatic infoStatic listParse list items
+parse value
+(default: false) whether to parse entries ~ Object.entries(value)
[list: any[], type:'values'|'entries']
Static logStatic successStatic tableconsole.tableuses process argument options as default values for params:
+cellMaxLength = --cellMaxLength=## (where ## is positive integer)divider = --divider | --divider=falsenoIndex = --noIndex | --noIndex=falsenumIndex = --numIndex | --numIndex=falselog data
+Optional cellMaxLength: number(default: 250) table max cell length (width)
Optional divider: boolean(default: false) whether to add row divider
Optional noIndex: boolean(default: false) whether to remove index column ([#])
Optional numIndex: boolean(default: false ~ 0) whether index column starts from 1
Static textStatic warnGenerated using TypeDoc
Generated using TypeDoc
Animates an object based on the provided options.
+The options to configure the animation.
+Optional _debug: boolean = falseEnables debug mode if true.
+The animation control object.
+ +Throws an error if the update callback is not defined in options.
+Generated using TypeDoc
Generated using TypeDoc
Parallel resolve list items <T=any>[]
queue list (supports promise or callback values)
+Optional callback: ((item, index, length) => Promise<TResult>)resolve queue item callback ~ supports parameters:
+item:T ~ next queue itemindex:number ~ next queue item indexlength:number ~ queued items countIPromiseResult[] with same indexOptional onProgress: ((percent, total, complete, failures) => void)queue on progress callback ~ supports parameters:
+percent:number ~ queue processed items percentage (integer 0 - 100)total:number ~ queued items countcomplete:number ~ queue resolved items countfailures:number ~ queue rejected items countPromise<IPromiseResult<TResult>[]>
await _asyncAll<number, number>([1, 2], async (num) => num * 2) //[{status:'resolved',index:0,value:2},{status:'resolved',index:1,value:4}]
await _asyncAll([() => Promise.resolve(1), 2], async (num) => num * 2) //[{status:'resolved',index:0,value:2},{status:'resolved',index:1,value:4}]
await _asyncAll([async () => Promise.resolve(2), 4]) //[{status:'resolved',index:0,value:2},{status:'resolved',index:1,value:4}]
+Generated using TypeDoc
Parallel resolve list items <T=any>[] with max simultaneous promises size limit
queue values
+max simultaneous promises size (default: 0 ~ unlimited)
Optional callback: ((value, index, length) => Promise<TResult>)queue resolve value callback ~ (value:T,index:number,length:number)=>Promise<TResult=any>
Optional onProgress: ((percent, total, complete, failures) => void)queue on progress callback ~ (percent:number,total:number,complete:number,failures:number)=>void
Promise<IPromiseResult<TResult>[]>
Generated using TypeDoc
Get async iterable values (i.e. for await (const value of _asyncValues(array)){...})
Values
+Async iterable object
+ +Generated using TypeDoc
Parse text from base to decimal
+parse text
+from base (default: 2) ~ 2 = binary, 8 - octal, 16 - hexadecimal
number|undefined ~ parsed decimal integer | undefined when invalid
_base2dec('0111 1110', 2) // 126
_base2dec('0o176', 8) // 126
_base2dec('0x7E', 16) // 126
+Generated using TypeDoc
Generated using TypeDoc
Base64 encode
+_base64Encode('Hello world!') => 'SGVsbG8gd29ybGQh'Optional bufferEncoding: BufferEncodingbase64 encoded string
Generated using TypeDoc
Get validated basename from file path value
+[\\/] uses last entry:?"<>|*)'...', 'name.', 'name...')parse path value
+allow dot nav ~ '.' | '..' (default: false)
strict parsing ~ returns blank ('') values on error
Optional _failure: 0 | 2 | 1error handling ~ 0 = ignore, '1' = warn, 2 = throw error (default 0)
IBasename basename (stringable)
IBasenameError
Generated using TypeDoc
Split array into batches T[][] of specified size.
Batch values
+Batch size x > 0.
<T = any>[][]
_batchValues<number>([1,2,3,4,5,6,7,8], 3) => [[1,2,3],[4,5,6],[7,8]]
+Generated using TypeDoc
Generated using TypeDoc
Get parsed boolean value
parse value
+strict mode ~ support only boolean-like value (i.e. 'true'|'false'|true|false|1|0) returns undefined if unsupported when enabled.
trim string value (default true)
booleanundefined when invalid if strict is enabled'false' => false | !!value when strict is disabledGenerated using TypeDoc
Convert bytes to size value
+parse bytes
+parse result mode (default: 0)
0 = string size text (e.g. _bytesVal(2097152) => 2 MB)1 = number size value (e.g. _bytesVal(2097152,1,'MB',0) => 2)Optional unit: "B" | "KB" | "MB" | "GB" | "TB" | "PB" | "EB" | "ZB" | "YB"size unit (default: undefined = max) ~ 'B'|'KB'|'MB'|'GB'|'TB'|'PB'|'EB'|'ZB'|'YB'
decimal places
+number
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Clones (copies) an Object using deep copying.
+This function supports circular references by default, but if you are certain
+there are no circular references in your object, you can save some CPU time
+by calling with option circular = false.
CAUTION: if option circular is false and value contains circular references,
+your program may enter an infinite loop and crash.
Clone subject <T>
Optional options: IDeepCloneOptionsClone options
+<T> clone
Generated using TypeDoc
Convert numeric value to comma thousand delimited string (i.e. 1000.4567 => '1,000.45')
Parse value
+[default: 2] Round decimal places
Enable trailing '0' decimal places (i.e. 1000 => '1,000.00')
string Comma thousand delimited number (returns "" if parsed value is NaN)
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Custom text encrypt/decrypt cypher ~ v20231027232850
text value ~ string
Optional index: anyindex offset ~ integer (default: 0)
Optional key: anyparse key ~ string (default: 'QWxvaG9tb3JhIQ')
string buffer | 'ERROR' on failure
Generated using TypeDoc
Parse Date value ~ accepts valid Date instance, timestamp integer, datetime string (see _strict param docs)
Date instance, integer|string timestamp in milliseconds and other string date texts1 timestamp millisecondsundefined = new Date() and null|false|true|0 = new Date(null|false|true|0)parse date value
+enable strict parsing (default: true)
Date instance | undefined when invalid
Generated using TypeDoc
Parse Date value to YYYY-MM-DD format string (e.g. '2023-05-27')
_date() parsing docsOptional value: anyparse date value
+enable strict datetime parsing (default: false) ~ see _date()
string ~ 'YYYY-MM-DD' | empty '' when invalid
Generated using TypeDoc
Parse Date value to YYYY-MM-DD HH:mm:ss format (e.g. '2023-05-27 22:11:57')
_date() parsing docsOptional value: anyparse date value
+enable strict datetime parsing (default: false) ~ see _date()
string ~ 'YYYY-MM-DD HH:mm:ss' | empty '' when invalid
Generated using TypeDoc
Parse Date day end ~ at 23:59:59 999
_date() parsing docsOptional value: anyparse date value ~ (defaults to new Date() when invalid)
enable strict datetime parsing (default: false)
Date
Generated using TypeDoc
Generated using TypeDoc
Parse Date day start ~ at 00:00:00 0
_date() parsing docsOptional value: anyparse date value ~ (defaults to new Date() when invalid)
enable strict datetime parsing (default: false)
Date
Generated using TypeDoc
Create debounced callback function
+Throttled callback handler
+Rest ...args: anyCallback delay milliseconds
+Maximum callback delay milliseconds
+Execute callback before delay
+Throttled callback function
+ +Rest ...args: anyGenerated using TypeDoc
Convert decimal to base
+parse decimal integer
+to base (default: 2) ~ 2 = binary, 8 - octal, 16 - hexadecimal
space group characters length (default: 0) ~ enabled when base = 2|16
string
_dec2base(126, 2) // '1111110'
_dec2base(126, 2, 4) // '0111 1110'
_dec2base(126, 8) // '176'
_dec2base(126, 16) // '7E'
_dec2base(1000, 16) // '03E8'
_dec2base(1000, 16, 2) // '03 E8'
+Generated using TypeDoc
Parse decimal to binary
+parse decimal integer
+space group characters length (default: 0)
string binary text
_dec2bin(126) // 1111110
_dec2bin(126, 4) // 0111 1110
_dec2bin(126, 8) // 01111110
+Generated using TypeDoc
Parse decimal to hexadecimal
+parse decimal integer number
space group characters length (default: 0)
string - hexadecimal text
_dec2hex(1000) // '03E8'
_dec2hex(1000, 2) // '03 E8'
+Generated using TypeDoc
Generated using TypeDoc
Convert degree to radian
+2π rad = 360° ∴ radian = degree * π/180angle in degrees (i.e. 0 - 360°)
+number - radian
Generated using TypeDoc
Get distance in meters between two latitude and longitude coordinates
+first coordinate latitude number
first coordinate longitude number
second coordinate latitude number
second coordinate longitude number
number m distance
TypeError when coorinate argument value is NaN
Generated using TypeDoc
Flatten object values recursively to dot paths
parse object value
omit entry keys/dot paths
+{[key: string]: any}
_dotFlat({a:{x:1},b:{y:2,z:[5,6]}}) //{'a.x':1,'b.y':2,'b.z.0':5,'b.z.1':6}
+Generated using TypeDoc
Resolve dot path object value ~ supports array operations chaining
+dot separated keys ~ optional array operations
+traverse object
+whether to ignore case when matching keys (default: false)
FailError mode ~ 0 = silent (default) | 1 = logs warning | 2 = logs error | 3 = throws error
Optional _default: anydefault result on failure
+any dot path match result
//simple usage
_dotGet('x', {'x':1}) => 1
_dotGet('a.b.c', {'a':{'b':{'c':1}}}) => 1
_dotGet('a.b.d', {'a':{'b':{'c':1}}}) => null
_dotGet('a.0', {'a':['x','y']}) => 'x'
//array reverse operation (done slice copy)
_dotGet('0.!reverse', [[3,2,1]]) => [3,2,1]
//array slice operation
_dotGet('0.!slice', [[1,2,3]]) => [1,2,3]
//array slice negative `-number`
_dotGet('0.-2', [[1,2,3]]) => [2,3]
//array `key=value` searching
_dotGet('0.a=2', [[{'a':1,'b':2},{'a':2,'b':3}]]) => {'a':2,'b':3}
_dotGet('0.a=1,b=2', [[{'a':1,'b':2,'c':3},{'a':2,'b':3,'c':4}]]) => {'a':1,'b':2,'c':3}
+Generated using TypeDoc
Unflatten dot flattened object ~ reverse of _dotFlat
parse value ~ {[dot_path: string]: any}
{[key: string]: any} parsed result | {} when value is invalid
_dotInflate({'a.x':1,'b.y':2,'b.z.0':5,'b.z.1':6}) //{a:{x:1},b:{y:2,z:[5,6]}}
+Generated using TypeDoc
Get dump value with limit max string length
+parse value
+max string length [default: 200]
summarize object array to count and first entry (i.e. {count:number,first:any})
any - dump value
Generated using TypeDoc
Get elapsed duration between two dates/timestamps ~ closest estimation
+start date/ms timestamp
+end date/ms timestamp (default: 0)
enable strict datetime parsing (default: false) ~ see _date()
IDuration
TypeError on invalid start/end time value
Generated using TypeDoc
Get elapsed duration between two dates/timestamps ~ extra accuracy considering leap years
+start date/timestamp
+end date/timestamp (default: undefined)
enable strict datetime parsing (default: false) ~ see _date()
IDuration
TypeError on invalid start/end time value
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The escape() function ~ deprecation-alt
+(A–Z, a–z, 0–9, _) and @\*_+-./.parse text
+string escaped text
Generated using TypeDoc
Get normalized file/directory path (validates basename)
+:?"<>|*)'...', 'name.', 'name...')'/.' => '/', 'a/b/./c' => 'a/b/c', './a/../b/c' => './b/c') ignores out of bound (i.e. 'C:/a/../../b/c' => 'C:/b/c')'c:\\a.txt' => 'C:\\a.txt', 'c:' => 'C:\\')parse path value
+Optional separator: "" | "\\" | "/"result path separator ~ '' | '/' | '\\' (default '' = unchanged)
strict parsing ~ returns blank ('') values on error
Optional _type: stringpath type (default '') ~ name used in error message (i.e. 'The ${_type} path...')
Optional _failure: 0 | 2 | 1error handling ~ 0 = ignore, '1' = warn, 2 = throw error (default 0)
IFilePath normalized path (stringable)
Generated using TypeDoc
Get all value properties
+parse value object
+include static class properties
(string|number|symbol)[] - found own/prototype/symbol properties | [] when none found
Generated using TypeDoc
Get all property descriptors
+ +parse value object
+{[key: string|number|symbol]: any} ~ {property => descriptors} object
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Check if value has property
+parse object value
property name
+[default: false] As own property
boolean
Generated using TypeDoc
Generated using TypeDoc
Parse text value hash code using hash53
+cyrb53 script by bryc (https://stackoverflow.com/a/52171480/3735576)parse text value
+hash entropy seed
+number ~ 53-bit hash code (length=16) | 0 when blank
_hash53('Hello world!') => 5211024121371232
+Generated using TypeDoc
Generated using TypeDoc
Parse text value hash code in string format ~ uses _hashCode(value) but prepends 'n' when result number is negative and 'x' when positive
parse text value
+string ~ has code text
_hashCodeStr('Hello world!') => 'n52966915'
_hashCodeStr('Hello') => 'x69609650'
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Validate values iterable array list
+parse value
+must not be empty []
parse mode
+0 = (default) [Symbol.iterator].name is 'values'|'[Symbol.iterator]'1 = Array.isArray2 = is iterable [Symbol.iterator]boolean
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Validate URL string (uniform resource locator)
parse url string value
validation includes data URI (i.e. 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD')
+boolean - valid url
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Custom JSON.stringify with extended custom replacer
undefined value argumentError, Set, Map stringifyParse value (undefined value is replaced with _undefined argument substitute value)
Optional space: null | string | numberIndentation space
+Default undefined argument value substitute (default null)
Generated using TypeDoc
Parse key value text ~ escapes/restores values delimiter (i.e. '=') and entries delimiter (i.e. '\n')
parse value text (string)
whether to escape delimiters (default: false ~ restore)
value delimiter (default: '=' ~ e.g. 'key=value')
entries delimiter (default: '\n' ~ e.g. 'key=value\nkey2=value2')
string
Generated using TypeDoc
Generated using TypeDoc
Regex string trim leading characters (left)
+Trim value
+Strip characters [default: ' \n\r\t\f\v\x00'] - use '{default}' to include defaults (i.e '-{defaults}' == '- \n\r\t\f\v\x00')
left trimmed string
Generated using TypeDoc
Map values (object[]) by key property ID value
string (lowercase when argument _lowercase is true)parse values array ~ <T = any>[]
ID property name (default: '' ~ uses string entry value as ID for scalar values array)
(default: false) use lowercase ID value for uniform ID value case
(default: 0) parse text entry mode ~ enabled when prop argument is blank
0 => disabled1 => trim text values2 => stringify and trim text values(default: true) do not log warnings when values entry with invalid ID is skipped
{[id: string]: T} object with {ID=entry} mapping
Generated using TypeDoc
Parse file mime type
+parse mime type
+FailError mode ~ 0 = silent (default) | 1 = logs warning | 2 = logs error | 3 = throws error
IMimeType stringable mime type object
String(_mime('application/json; charset=utf-8')) => 'application/json'
+Generated using TypeDoc
Generated using TypeDoc
Parse Date month's end day ~ at 23:59:59 999
_date() parsing docsOptional value: anyparse date value ~ (defaults to new Date() when invalid)
enable strict datetime parsing (default: false) ~ see _date()
Date
Generated using TypeDoc
Generated using TypeDoc
Parse Date month's start day ~ at 00:00:00 0
_date() parsing docsOptional value: anyparse date value ~ (defaults to new Date() when invalid)
enable strict datetime parsing (default: false) ~ see _date()
Date
Generated using TypeDoc
Get parsed and normalized number
string value and '' => NaN'1, 200, 000 . 3455' => 1200000.3455)3+ last zeros from 5th place (i.e. 1.1/100 = 0.011000000000000001 => 0.011)parse number value
+default number result when invalid (default NaN)
number | NaN when invalid or when ''
Generated using TypeDoc
Generated using TypeDoc
Get number in k (thousand)to maxT` (trillion) SI Symbol value group
'k' Thousand'M' Million'B' Billion'T' Trillion@param value - parse number
+@param places - decimal places (0 - 3)
+@returns string number text
Generated using TypeDoc
Generated using TypeDoc
Parse csv data into 2d string array
+parse text
+Optional delimiter: stringdelimiter character (default: ',')
Optional br: stringnew line (default: '\n')
string[][] ~ [[...cols], ...rows]
Generated using TypeDoc
Parse data URI (uniform resource identifier)
+parse data uri value
+IDataUri ~ {mime:string;encoding:string;charset:string;data:string}undefined on error_parseDataUri('data:text/plain;charset=utf-8,Hello%20world%21') => {
mime: 'text/plain',
encoding: 'charset=utf-8',
charset: 'utf-8',
data: 'Hello%20world%21',
}
_parseDataUri('data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD') => {
mime: 'image/jpeg',
encoding: 'base64',
charset: '',
data: '/9j/4AAQSkZJRgABAgAAZABkAAD',
}
+Generated using TypeDoc
Parse ISO formatted date value to milliseconds timestamp
+ +ISO date string (i.e. '2022-12-19T13:12:42.000+0000'/'2022-12-19T13:12:42.000Z' => 1671455562000)
number milliseconds timestamp | undefined when invalid
Generated using TypeDoc
Parse serialized key values ~ (i.e. 'key=value\nkey2=value2')
parse serialized text
+whether to escape delimiters (default: false ~ restore)
value delimiter (default: '=' ~ e.g. 'key=value')
entries delimiter (default: '\n' ~ e.g. 'key=value\nkey2=value2')
[key: string, value: string][] entries list with unique keys
Generated using TypeDoc
Create/resume pending promise
+unique promise key/name/ID ~ string (i.e. String(Date.now()))
promise instance creator callback ~ ()=>Promise<TResult>
new pending behavior when key duplicate exists:
0 = ignore (default) ~ resolve pending1 = replace ~ replace pending promise2 = retry ~ resolve next if pending promise rejection3 = chain ~ resolve next after pending promise is done (resolves/rejects)whether to keep resolved promise in cache (default: false) ~ pending promises are automatically removed from cache by default or on rejection.
IPendingPromise ~ extends Promise<any>
Generated using TypeDoc
Abort cached pending promises
+whether to remove aborted promise from cache (default: false)
Optional key: stringspecify cached promise key to abort (default: all ~ when key is undefined/blank)
Optional reason: stringspecify abort reason (default: 'aborted')
void
Generated using TypeDoc
Get parsed safe positive integer value with optional within min/max limit check
parse number value
+Optional min: numberset min limit ~ enabled when min is a valid positive number
Optional max: numberset max limit ~ enabled when max is a valid positive number
(default: false) use min/max value when value goes beyond limit (e.g. _posInt(150,0,100,true) => 100)
number positive | undefined when invalid or out of min/max bounds
Generated using TypeDoc
Get parsed safe positive number with optional within min/max limit check
parse number value
+Optional min: numberset min limit ~ enabled when min is a valid positive number
Optional max: numberset max limit ~ enabled when max is a valid positive number
number positive | undefined when invalid or out of min/max bounds
Generated using TypeDoc
Extract object value property entries
parse object value
Optional props: any[]extract property names
+(default: false) exclude property names extract mode
(default: false) include undefined property names
{[prop: any]: any}
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Convert radian to degree
+2π rad = 360° ∴ radian = degree * π/180angle in radians (i.e. 0 - 360°)
+number - degree
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Resolve promise callback/value
+call context
+resolve ~ ()=>Promise<any>|any callback result | any value
whether to return new promise
+Promise<any> ~ Promise.resolve value/result
Generated using TypeDoc
Generated using TypeDoc
Regex string trim trailing characters (right)
+Trim value
+Strip characters [default: ' \n\r\t\f\v\x00'] - use '{default}' to include defaults (i.e '-{defaults}' == '- \n\r\t\f\v\x00')
right trimmed string
Generated using TypeDoc
Generated using TypeDoc
Get objects array with keys selection
+parse iterable/spreadable objects array {[key:string]:any}[]
select keys string[]
(default: false) false disabled, true omit select keys, string[] omit keys
(default: false) omit keys that are empty values in all array items or omit item that have empty values in all keys
{[key:string]:any}[] selection
Generated using TypeDoc
Generated using TypeDoc
Sort Array slice values
array.slice().sort(...) does not affect original arrangement)sort Array
Optional mode: TSortMode | { sort mode
+Optional onCompare: ((a, b, key?) => TSortOrder | [a: any, b: any])custom compare callback
+Optional key: stringOptional localeCompareConfig: { method config String.localeCompare (default: {locales:'en',options:{sensitivity:'base'}}) ~ options.sensitivity
Optional locales?: anyOptional options?: anySorted T[]
Generated using TypeDoc
Split string value into parts ~ part and separator array (last entry's separator is '')
split string
+Optional separator: string | RegExpsplit separator (default: undefined)
Optional limit: numbersplit items limit/count (default: undefined)
[part: string, separator: string | ''][] split parts
Generated using TypeDoc
Escape SQL special characters from query string value
parse string
string with special characters escaped ~ '\\'"\0\n\r\x1a'number (unchanged) when type is number and not NaNboolean (unchanged) when type is true or falsenull when type is undefined|NaN|nullGenerated using TypeDoc
Convert value to string equivalent
null and undefined valuestringify is false, returns '' for array or object value that does not implement toString() methodTrim result
+Stringify array or object value that does not implement toString() method
string
Generated using TypeDoc
Generated using TypeDoc
Serialize key values ~ (i.e. ['key','value','key2','value2'] => 'key=value\nkey2=value2')
parse values ~ (i.e. string|string[]|[string,string][]|{[key:string]:string}[])
Optional _key: anyspecify entry key property name when values is {[key:string]:string}[]
Optional _value: anyspecify entry value property name when values is {[key:string]:string}[]
string serialized key values
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Get text with max length limit
+parse text
+max characters length (default: 1000)
result mode
+0 = substring(0, max)1 = substring(0, max - 3) + '...'2 = substring(0, max - [append].length) + [append] where [append] is '...(' + value.length + ')'string ~ whose character length is <= max
Generated using TypeDoc
Parsed Date timestamp value (i.e. date.getTime())
_date() parsing docsparse date value
+Optional min: numberset min timestamp limit ~ enabled when min is a valid timestamp integer
Optional max: numberset max timestamp limit ~ enabled when max is a valid timestamp integer
enable strict parsing (default: true)
number timestamp in milliseconds | undefined when invalid
Generated using TypeDoc
Parse Date value to HH:mm:ss format string (e.g. '22:11:57')
_date() parsing docsOptional value: anyparse date value
+enable strict datetime parsing (default: false) ~ see _date()
string ~ 'HH:mm:ss' | empty '' when invalid
Generated using TypeDoc
Generated using TypeDoc
Convert data to csv text
+parse data
+Optional delimiter: stringdelimiter character (default: ',')
Optional br: stringnew line replace (default: '\n')
string csv text
Generated using TypeDoc
Generated using TypeDoc
Convert string to sentence case
+Parse string
+Disable lowercasing uncapitalized characters
+Sentence case string
Generated using TypeDoc
Generated using TypeDoc
Convert value to snake case (i.e. 'HelloWorld' => 'hello_world')
+Parse string
+Trim trailing "_" (false = (default) disabled, true => trim right & left, 'r'|'right' => trim right, 'l'|'left' => trim left)
snake_case string
Generated using TypeDoc
Generated using TypeDoc
Convert string to title case (i.e. "heLLo woRld" => "Hello World")
+Parse string
+Disable lowercasing uncapitalized characters
+Title Case string
Generated using TypeDoc
Generated using TypeDoc
Parse transform text template context values
+parse template ~ text with value template (e.g. 'My name is {user.name}')
values context ~ {[name: string]: any}
default value when unable to resolve template value (default: 'NULL')
Optional _format: ((value, path, name) => any)format resolved value callback (this allows you to further edit resolved template context values)
+string transformed text where template values are replaced with resolved context values (see examples)
_trans('My name is {user.name}.', {User: {Name: 'Root'}}, 'NULL') => 'My name is Root.'
_trans('My phone number is {user.phone}.', {User: {Name: 'Root'}}, 'NULL') => 'My phone number is NULL.'
_trans('address.city', {Address: {City: 'Nairobi'}}, 'NULL') => 'Nairobi'
_trans('address.town', {Address: {City: 'Nairobi', town: undefined}}, 'NULL') => 'undefined'
_trans('No template.', {foo: 'bar'}, 'NULL') => 'No template.'
_trans('KES {item.amount}/=', {item: {amount: 4500}}, 'NULL', (value:string,path:string,name:string) => _commas(value, true, 2)) => 'No template.'
+Generated using TypeDoc
Dump tree structure
+parse value
+Optional options: ITreeOptionsITreeOptions ~ (see ITreeOptions docs)
string
Generated using TypeDoc
Regex string trim characters
+Trim value
+Strip characters [default: ' \n\r\t\f\v\x00'] - use '{default}' to include defaults (i.e '-{defaults}' == '- \n\r\t\f\v\x00')
Trim mode ('' => (default) trim right & left, 'r'|'right' => trim right, 'l'|'left' => trim left)
trimmed string
Generated using TypeDoc
The unescape() function ~ deprecation-alt
+_escape()parse text
+string unescaped text
Generated using TypeDoc
Generated using TypeDoc
UTF8 encode text ~ REF
+parse text
+string UTF8 encoded text
Generated using TypeDoc
Get unique string of random characters string ~ alphanumeric lowercase
Optional length: numberuuid length - integer number min=7, max=64 (default 16)
Optional template: stringuuid template - trimmed string ~ appends when '{uuid}' not in template
unique string ~ alphanumeric lowercase (length[min: 7, max: 64])
_uuid() => 'g9eem5try3pll9ue' 16
_uuid(20) => 'k6yo2zgzodjll9uers4u' 20
_uuid(7, 'test_') => 'test_3bmxj2t' 12
_uuid(7, 'test_{uuid}_example') => 'test_lk9r5tv_example' 20
_uuid(7, 'test_{uuid}_{uuid}_example') => 'test_g948vqf_0s6ms8y_example' 28
+Generated using TypeDoc
Get validated object dot path (i.e. 'a.b.c' to refer to {a:{b:{c:1}}})
dot separated keys
+supports operations (i.e. '!reverse'/'!slice=0') ~ tests dot keys using /^[-_0-9a-zA-Z]+\=([^\=\.]*)$/ instead of default /^[-_0-9a-zA-Z]+$/
FailError mode ~ 0 = silent (default) | 1 = logs warning | 2 = logs error | 3 = throws error
string valid dot path
Generated using TypeDoc
Generated using TypeDoc
Object array values
+parse array value
+enable get entries (i.e. [key: any, value: any][]) instead of default values (i.e. any[])
enable get Object.values(value)/Object.entries(value)
Optional flatten: null | number | booleanflatten depth ~ Array.flat depth (alias: -1 => Array.flat(Infinity), true|null => Array.flat())
any[] values or [key: any, value: any][] when entries argument is true[value] when value argument is not iterable or arrayable[] when value argument is empty ~ []/{}/undefinedGenerated using TypeDoc
Text wrap lines on length limit
+parse text
+max line length
+whether to use word break (default false)
Optional onAddLine: ((line, lines_buffer) => undefined | string)add line buffer handler callback ~ return modified line value or undefined|null to skip
string[] text wrap lines
Generated using TypeDoc
Generated using TypeDoc
Parse Date year's end day ~ at YYYY-12-31 23:59:59 999
_date() parsing docsOptional value: anyparse date value ~ (defaults to new Date() when invalid)
enable strict datetime parsing (default: false) ~ see _date()
Date
Generated using TypeDoc
Parse Date year's start day ~ at YYYY-01-01 00:00:00 0
_date() parsing docsOptional value: anyparse date value ~ (defaults to new Date() when invalid)
enable strict datetime parsing (default: false) ~ see _date()
Date
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Options for configuring an animation.
+Optional afterFunction called after the animation ends.
+The final state after the animation ends.
+The method used to abort the animation, if applicable.
+Indicates if the animation was aborted.
+Indicates if the animation completed successfully.
+The total duration of any pauses during the animation.
+The total duration of the animation.
+Optional autoplayIndicates if the animation plays automatically.
+Optional beforeFunction called before the animation starts.
+The initial state before the animation starts.
+The options provided to the animation.
+The initial time offset.
+The timestamp when the animation is about to start.
+Optional delayThe delay before the animation starts in milliseconds.
+Optional delayedIndicates if the animation is delayed.
+The duration of the animation in milliseconds.
+The easing function or key to use for the animation.
+Optional fromThe initial position of the animation.
+Optional timeoutThe timeout for the animation in milliseconds.
+Optional toThe final position of the animation.
+Function called to update the animation.
+The current state of the animation.
+The change in position from the last frame.
+The current frame index of the animation.
+The current position of the animation.
+The current time of the animation.
+Generated using TypeDoc
Interface representing an animation with various control methods and state properties.
+Indicates whether debug mode is enabled.
+Aborts the animation.
+Indicates whether the animation has begun.
+Indicates whether the animation is completed.
+Pauses the animation.
+Optional toggle: booleanIf true, toggles the pause state.
+Indicates whether the animation is currently paused.
+Starts or restarts the animation.
+Optional restart: booleanIf true, restarts the animation from the beginning.
+Reset the animation.
+Restarts the animation from the beginning.
+Resumes the animation from a paused state.
+Generated using TypeDoc
Basename (stringable) object interface
+Get basename text
+Optional prop: "error" | "name" | "ext" | "basename"text value prop
+string
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Deep clone options interface
+Optional circular[default: true] Enable circular references (can also be object with options {circular, depth, prototype, non_enumerable})
Optional depth[default: Infinity] Clone depth limit (leave default to prevent references to parent).
Optional non_[default: false] Enable cloning non-enumerable properties (ignores prototype chain non-enumerable props)
Optional prototype[default: undefined] Use prototype.
Generated using TypeDoc
Duration interface
+Optional mode: numbertext mode (default: 0) ~ 0 = short, 1 = long (see docs)
string
_duration(182458878).toString(0?) //'2 days 02:40:58' (short)
_duration(182458878).toString(1) //'2 days, 2 hours, 40 minutes, 58 seconds and 878 milliseconds' (long)
+Math.floor((time_difference_ms)/(24*60*60*1000)))Math.abs(time_difference_ms))Generated using TypeDoc
Generated using TypeDoc
Exception error interface
+Generated using TypeDoc
Normalized path (stringable) interface
+Get path text
+Optional prop: "error" | "file" | "name" | "dir" | "path" | "ext" | "basename" | "root" | "drive"text value prop
+string
Generated using TypeDoc
Generated using TypeDoc
Mime type object interface
+'png')string castOptional prop: "type" | "error" | "ext"get property (default: 'type')
string
'image/png')Generated using TypeDoc
Pending promise item interface
+AbortPendingError reasonOptional reason: stringspecify abort reason (default: 'aborted')
Optional abort0 = pending, 1 = resolved, -1 = rejectedGenerated using TypeDoc
Pending promise interface ~ extends Promise<any>
Readonly [toAttaches a callback for only the rejection of the Promise.
+Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)The callback to execute when the Promise is rejected.
+A Promise for the completion of the callback.
+ +Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The +resolved value cannot be modified from the callback.
+Optional onfinally: null | (() => void)The callback to execute when the Promise is settled (fulfilled or rejected).
+A Promise for the completion of the callback.
+ +Attaches callbacks for the resolution and/or rejection of the Promise.
+Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)The callback to execute when the Promise is resolved.
+Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)The callback to execute when the Promise is rejected.
+A Promise for the completion of which ever callback is executed.
+ +Generated using TypeDoc
Generated using TypeDoc
Property interface ~ see _getProp()
0 = not found1 = own property2 = not own propertyGenerated using TypeDoc
Generated using TypeDoc
Task interface
+Generated using TypeDoc
Tasks data interface
+Generated using TypeDoc
Term format result interface
+Rest ...args: any[]Optional message: anyRest ...optionalParams: any[]Optional message: anyRest ...optionalParams: any[]Rest ...args: any[]Optional message: anyRest ...optionalParams: any[]Optional message: anyRest ...optionalParams: any[]Rest ...args: any[]Optional message: anyRest ...optionalParams: any[]Generated using TypeDoc
Tree options interface
+Optional blanksignore blank key values ~ i.e. null|undefined|'' (default: false)
Optional max_max text value length (default: 200)
Optional nameTree name ~ root node label
+Optional padString line start padding length
+Optional word_whether to use word break (default false)
Optional wrap_text value wrap break length (default: 56)
Generated using TypeDoc
Generated using TypeDoc
Buffer encoding
+Generated using TypeDoc
Buffer string type
+Generated using TypeDoc
A function that defines an easing calculation.
+The current time (or position) of the tween.
+The beginning value of the property being animated.
+The change in value of the property being animated.
+The total duration of the tween.
+Generated using TypeDoc
An object where the keys are strings and the values are easing functions.
+Generated using TypeDoc
The keys of the TEasings type, representing the names of the easing functions.
+Generated using TypeDoc
Sort mode type ~ 1|-1|'asc'|'desc'|'ascending'|'descending'
Generated using TypeDoc
Sort order type ~ -1 (before) | 1 (after) | 0 (equal)
Generated using TypeDoc
Task status type
+Generated using TypeDoc
With implicit coercion type
+Generated using TypeDoc
Type boolean equivalent
+Generated using TypeDoc
Const The default duration for animations, in milliseconds.
+Generated using TypeDoc
Const Buffer object
+Generated using TypeDoc
Const Day unit milliseconds
+24 * 60 * 60 * 1000 = 86400000 msGenerated using TypeDoc
Const Day names
+('Sunday'|'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday')[]Generated using TypeDoc
Const File extension mime types
+Generated using TypeDoc
Const Generated using TypeDoc
Generated using TypeDoc
Const Hour unit milliseconds
+60 * 60 * 1000 = 3600000 msGenerated using TypeDoc
Const Minute unit milliseconds
+60 * 1000 = 60000 msGenerated using TypeDoc
Const Month unit milliseconds ~ close estimate 30.44 days
30.44 * 24 * 60 * 60 * 1000 = 2630016000.0000005 msGenerated using TypeDoc
Const Month names
+('January'|'February'|'March'|'April'|'May'|'June'|'July'|'August'|'September'|'October'|'November'|'December')[]Generated using TypeDoc
Generated using TypeDoc
Const Second unit milliseconds
+1000 msGenerated using TypeDoc
Generated using TypeDoc
Const Year unit milliseconds ~ close estimate 365.25 days
365.25 * 24 * 60 * 60 * 1000 = 31557600000 msGenerated using TypeDoc
Alphabetical integer
+