@speedup/string-to
Version:
Convert all the string variables into their actual data type using different parsers
53 lines (52 loc) • 2.03 kB
TypeScript
/**
* Integer parser
*/
import validator from 'validator';
import { Parser as IParser } from '../type/parser';
export declare class Parser implements IParser<number> {
/**
* Validate string and check whether its possible to parse as integer
* @param val String value to parse
* @param options validator.IsIntOptions
*/
validateSync(val?: string, options?: validator.IsIntOptions): boolean;
/**
* Validate string and check whether its possible to parse as integer
* @param val String value to parse
* @param options validator.IsIntOptions
*/
validate(val?: string, options?: validator.IsIntOptions): Promise<boolean>;
/**
* Parse a string into an integer number
* @param val String value to parse
* @param options radix (the second parameter in parseInt method)
*/
parseSync(val?: string, options?: number): number;
/**
* Parse a string into an integer number
* @param val String value to parse
* @param options radix (the second parameter in parseInt method)
*/
parse(val?: string, options?: number): Promise<number>;
/**
* Validate and parse the value
* @param val String value to parse
* @param defaultValue Default value if the provided string is not a valid number
* @param options Contains both validator and parser options
*/
validateAndParseSync(val?: string, defaultValue?: number, options?: {
validatorOptions?: validator.IsIntOptions;
parserOptions?: number;
}): number | undefined;
/**
* Validate and parse the value
* @param val String value to parse
* @param defaultValue Default value if the provided string is not a valid number
* @param options Contains both validator and parser options
*/
validateAndParse(val?: string, defaultValue?: number, options?: {
validatorOptions?: validator.IsIntOptions;
parserOptions?: number;
}): Promise<number | undefined>;
}
export declare const parser: Parser;