ts-prime
Version:
A utility library for JavaScript and Typescript.
42 lines • 1.77 kB
TypeScript
/**
* Parses date and if success returns Date object otherwise returns undefined
* @description
* If for example we want parse data new Date("asd") this will be invalid date and javascript will not return exception. So for every date parsing we need to do additional validity checks
* @param data - Anything
* @example
* P.toFloat("1.378998") // = 1.378998
* P.toFloat("test") // undefined
* P.toFloat("test", 0) // 0
* @category Number
*/
export declare function toDate(data: string | number | Date): Date | undefined;
export declare function toDate(data: string | number | Date, defaultValue: Date): Date;
/**
* Parses string to `floating` number
* @description
* This function litle bit different than parseFloat. First of all it can return undefined if float parsing is unsuccessful.
* Regular parseFloat return `NaN` this is really misleading
* @param data - Anything
* @example
* P.toFloat("1.378998") // = 1.378998
* P.toFloat("test") // undefined
* P.toFloat("test", 0) // 0
* @category Number
*/
export declare function toFloat(data: unknown): number | undefined;
export declare function toFloat<T extends number>(data: unknown, defaultValue: T): number;
/**
* Parses string to `int` number
* @description
* This function litle bit different than parseInt. First of all it can return undefined if int parsing is unsuccessful.
* Regular parseInt cant return `NaN` and this is really misleading
* @param data - Anything
* @example
* P.toInt("1.378998") // = 1
* P.toInt("test") // undefined
* P.toInt("test", 0) // 0
* @category Number
*/
export declare function toInt(data: unknown): number | undefined;
export declare function toInt<T extends number>(data: unknown, defaultValue: T): number;
//# sourceMappingURL=parse.d.ts.map