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

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

/**
 * Float 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 float
     * @param val String value to parse
     * @param options validator.IsFloatOptions
     */
    validateSync(val?: string, options?: validator.IsFloatOptions): boolean;
    /**
     * Validate string and check whether its possible to parse as float
     * @param val String value to parse
     * @param options validator.IsFloatOptions
     */
    validate(val?: string, options?: validator.IsFloatOptions): Promise<boolean>;
    /**
     * Parse a string into an float number
     * @param val String value to parse
     * @param options No option is accepted
     */
    parseSync(val?: string, options?: void): number;
    /**
     * Parse a string into an float number
     * @param val String value to parse
     * @param options No option is accepted here
     */
    parse(val?: string, options?: void): 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.IsFloatOptions;
        parserOptions?: void;
    }): 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?: void;
    }): Promise<number | undefined>;
}
export declare const parser: Parser;