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

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

/**
 * Boolean parser
 */
import { Parser as IParser } from '../type/parser';
export declare type BoolParserOptions = {
    /**
     * Values that are considered as true
     */
    trueValues: Array<string>;
    /**
     * Values that are considered as false
     */
    falseValues: Array<string>;
    /**
     * Consider case in comparisons
     */
    caseSensitive: boolean;
};
export declare const defaultOptions: BoolParserOptions;
export declare class Parser implements IParser<boolean> {
    /**
     * Validate string and check whether its possible to parse as boolean
     * @param val String value to parse
     * @param options Boolean parser options
     */
    validateSync(val?: string, options?: BoolParserOptions): boolean;
    /**
     * Validate string and check whether its possible to parse as boolean
     * @param val String value to parse
     * @param options Boolean parser options
     */
    validate(val?: string, options?: BoolParserOptions): Promise<boolean>;
    /**
     * Parse a string into a boolean
     * @param val String value to parse
     * @param options Boolean parser options
     */
    parseSync(val?: string, options?: BoolParserOptions): boolean;
    /**
     * Parse a string into a boolean
     * @param val String value to parse
     * @param options Boolean parser options
     */
    parse(val?: string, options?: BoolParserOptions): Promise<boolean>;
    /**
     * Validate and parse the value
     * @param val String value to parse
     * @param defaultValue Default value for the time that the value is neither in true nor in false values
     * @param options Contains both validator and parser options
     */
    validateAndParseSync(val?: string, defaultValue?: boolean, options?: {
        validatorOptions?: BoolParserOptions;
        parserOptions?: BoolParserOptions;
    }): boolean | undefined;
    /**
     * Validate and parse the value
     * @param val String value to parse
     * @param defaultValue Default value for the time that the value is neither in true nor in false values
     * @param options Contains both validator and parser options
     */
    validateAndParse(val?: string, defaultValue?: boolean, options?: {
        validatorOptions?: BoolParserOptions;
        parserOptions?: BoolParserOptions;
    }): Promise<boolean | undefined>;
}
export declare const parser: Parser;