@toreda/strong-types/dist/map/parser.d.ts

Better TypeScript code in fewer lines.

/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 2021 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */
import type { Data } from '@toreda/types';
import { StrongMap } from '../map';
import { Strong } from '../strong';
import { MapParserOptions as Options } from './parser/options';
import { MapParserState as State } from './parser/state';
/**
 * Recursively parse provided object properties.
 *
 * @category Strong Map
 */
export declare class MapParser {
    parse(map: StrongMap, data?: Data | unknown | null, options?: Options): boolean;
    parseStrongKey(key: Strong, value: unknown, _parseState: State): void;
    parseKey(map: StrongMap, keyName: string, value: unknown, _parseState: State): boolean;
    /**
     * Recursively parse map and children.
     * @param map			Map to match properties against and store parsed values.
     * @param json			Object to parse into map.
     * @param parseState	Internal state for current parse.
     * @returns				Boolean indicating success or failure.
     *						true	- 	Map parse successful.
     *						false	-	Map parse not successful.
     */
    parseMap(map: StrongMap, data: unknown | null, parseState: State): boolean;
}