@speedup/string-to/dist/parser/number.d.ts

Convert all the string variables into their actual data type using different parsers

/**
 * Number parser (int or float)
 */
import validator from 'validator';
import { Parser as IParser } from '../type/parser';
export declare class Parser implements IParser<number> {
    /**
     * Parse a string into an integer number
     * @param val String value to parse
     * @param options Combination of both intValidatorOptions and floatValidatorOptions
     */
    validateSync(val?: string, options?: {
        intValidatorOptions?: validator.IsIntOptions;
        floatValidatorOptions?: validator.IsFloatOptions;
    }): boolean;
    /**
     * Parse a string into an integer number
     * @param val String value to parse
     * @param options Combination of both intValidatorOptions and floatValidatorOptions
     */
    validate(val?: string, options?: {
        intValidatorOptions?: validator.IsIntOptions;
        floatValidatorOptions?: validator.IsFloatOptions;
    }): Promise<boolean>;
    /**
     * Parse a string into either an integer or a float
     * @param val String value to parse
     * @param options
     */
    parseSync(val?: string, options?: {
        intParseOptions?: number;
    }): number;
    /**
     * Parse a string into either an integer or a float
     * @param val String value to parse
     * @param options radix (the second parameter in parseInt method)
     */
    parse(val?: string, options?: {
        intParseOptions?: 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?: {
            intValidatorOptions?: validator.IsIntOptions;
            floatValidatorOptions?: validator.IsFloatOptions;
        };
        parserOptions?: {
            intParseOptions?: 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?: {
            intValidatorOptions?: validator.IsIntOptions;
            floatValidatorOptions?: validator.IsFloatOptions;
        };
        parserOptions?: {
            intParseOptions?: number;
        };
    }): Promise<number | undefined>;
}
export declare const parser: Parser;