dabbjs/dist/lib/dab.d.ts

general javascript library

declare const c: any;
export { c as consts };
/**
 * type of argument
 *
 * @param t any
 * @returns '[object Undefined | Null | Number | String | Boolean | Array | Object | Function, Date, RegExp]'
 */
export declare const ts: (t: any) => string;
/**
 * returned values: undefined, null, number, string, boolean, array, object, function, date, regexp
 * @param o any
 */
export declare const typeOf: (o: any) => string;
/**
 * returns true if argument is an string
 * @param f any
 * @returns
 */
export declare const isStr: (s: any) => boolean;
/**
 * returns true if argument is a function
 * @param f any
 * @returns
 */
export declare const isFn: (f: any) => boolean;
/**
 * it can be extended later object {}
 * @param s any
 * @returns `true` for undefined, void 0, 0, false, "", "  ", []
 */
export declare const empty: (s: any) => boolean;
/**
 * returns true if argument is defined,
 *
 * undefined === void 0
 *
 * @param t any
 */
export declare const dfnd: (t: any) => boolean;
/**
 * returns true if argument is an array
 * @param f any
 * @returns
 */
export declare const isArr: (t: any) => t is any[];
/**
 * returns true if n is number
 * @param n value
 *
 * - "1" returns false
 * - NaN returns true
 */
export declare const isNum: (n: any) => boolean;
/**
 * returns true if n is numeric
 * @param n
 *
 * - "1" returns true
 * - NaN returns false
 */
export declare const isNumeric: (n: any) => boolean;
export declare const isInt: (n: any) => boolean;
/**
 * parse a number according to a radix
 * @param s string value
 * @param radix convertion radix
 *
 * - "0101001" => 2		binary
 * - "0xFF"	=> 255 hexadecimal
 * - "123" => 123
 */
export declare const pInt: (s: string, radix?: number) => number;
/**
 * clamps a value inside a range min..max
 * @param v value
 * @param min minim
 * @param max maximum
 */
export declare const clamp: (v: number, min: number, max: number) => number;
/**
 * rounds a number to a decimal
 * @param v float value
 * @param decimals valid decimals
 *
 * - (123.5678, 1) => 123.6
 * - (123.5678, 0) => 124
 * - (123.5678, -1) => NaN
 */
export declare const round: (v: number, decimals: number) => number;
/**
 * converts a `defined` argument value to an array
 * @param o any
 * @returns
 */
export declare const splat: <T>(o: any) => T[];
/**
 * makes a child inherit or descend from its parent
 * @param parent parent
 * @param child child
 */
export declare const inherit: (parent: any, child: any) => void;
/**
 * returns true if argument is an object
 * @param t any
 */
export declare const isObj: (t: any) => boolean;
/**
 * plainObj   Plain Old JavaScript Object (POJO) {}
 * @param arg args
 */
export declare const pojo: (arg: any) => boolean;
/**
 * deep copy
 * @param o any
 */
export declare const obj: (o: any) => any;
/**
 * JSON stringify & parse cloner
 * @param o any
 */
export declare const clone: <T>(o: T) => T;
export declare const defEnum: (e: any) => any;
/**
 * defines a new object property
 * @param obj object
 * @param propName property name
 * @param attrs attributes
 */
export declare const dP: (obj: any, propName: string, attrs: object) => any;
/**
 * return true if value it's true or false, undefined if not valid
 * @param val any
 *
 * value can be:
 * - TRUE
 * - True
 * - true
 * - FALSE
 * - False
 * - false
 * - 1
 * - 0
 */
export declare const toBool: (val: any) => boolean | undefined;
/**
 * return true if value is a valid boolean
 * @param val any
 *
 * valid values are:
 * - TRUE
 * - True
 * - true
 * - FALSE
 * - False
 * - false
 * - 1
 * - 0
 */
export declare const isBool: (val: any) => boolean;
/**
 * converts a value to boolean, and undefined are forced to boolean
 * @param val value
 * @param forcedUndefined forced undefined values, default is "false"
 */
export declare const fBool: (val: any, forcedUndefined?: boolean) => boolean;
/**
 * parses an string and returns an array of parsed number values
 * @param s string in the form "n0, n1, n2, n3, n(n)"
 * @param l amount of valid numbers to parse
 * @returns number array if valid, undefined otherwise
 */
export declare const parse: (s: string, l: number) => number[] | undefined;