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

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

/**
 * Array parser
 */
import { Parser as IParser } from '../type/parser';
export declare type ArrayParserOptions = {
    /**
     * A single/multiple set
     */
    separator: string;
    /**
     * Maximum number of items (used in split function)
     */
    limit: number;
};
export declare const defaultOptions: ArrayParserOptions;
export declare class Parser implements IParser<Array<string>> {
    /**
     * Validate string and check whether its possible to parse as an array
     * @param val String value to parse
     * @param options No option is accepted
     */
    validateSync(val?: string, options?: void): boolean;
    /**
     * Validate string and check whether its possible to parse as an array
     * @param val String value to parse
     * @param options No option is accepted
     */
    validate(val?: string, options?: void): Promise<boolean>;
    /**
     * Parse a string into an array
     * @param val String value to parse
     * @param options Array parser options
     */
    parseSync(val?: string, options?: ArrayParserOptions): Array<string>;
    /**
     * Parse a string into an array
     * @param val String value to parse
     * @param options Array parser options
     */
    parse(val?: string, options?: ArrayParserOptions): Promise<Array<string>>;
    /**
     * 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?: Array<string>, options?: {
        validatorOptions?: void;
        parserOptions?: ArrayParserOptions;
    }): Array<string> | 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?: Array<string>, options?: {
        validatorOptions?: void;
        parserOptions?: ArrayParserOptions;
    }): Promise<Array<string> | undefined>;
}
export declare const parser: Parser;