@zeix/ui-element/src/lib/parsers.d.ts

UIElement - minimal reactive framework based on Web Components

import type { AttributeParser } from '../component';
/**
 * Parse a boolean attribute as an actual boolean value
 *
 * @since 0.7.0
 * @param {C} _ - host element
 * @param {string} value - maybe string value
 * @returns {boolean}
 */
declare const asBoolean: AttributeParser<HTMLElement, boolean>;
/**
 * Parse an attribute as as number forced to integer with a fallback
 *
 * @since 0.11.0
 * @param {number} [fallback=0] - fallback value
 * @returns {Parser<HTMLElement, number>} - parser function
 */
declare const asInteger: (fallback?: number) => AttributeParser<HTMLElement, number>;
/**
 * Parse an attribute as as number with a fallback
 *
 * @since 0.11.0
 * @param {number} [fallback=0] - fallback value
 * @returns {Parser<number, HTMLElement>} - parser function
 */
declare const asNumber: (fallback?: number) => AttributeParser<HTMLElement, number>;
/**
 * Parse an attribute as a string with a fallback
 *
 * @since 0.11.0
 * @param {string} [fallback=''] - fallback value
 * @returns {Parser<string, HTMLElement>} - parser function
 */
declare const asString: (fallback?: string) => AttributeParser<HTMLElement, string>;
/**
 * Parse an attribute as a multi-state value (for examnple: true, false, mixed), defaulting to the first valid option
 *
 * @since 0.9.0
 * @param {string[]} valid - array of valid values
 * @returns {Parser<string, HTMLElement>} - parser function
 */
declare const asEnum: (valid: [string, ...string[]]) => AttributeParser<HTMLElement, string>;
/**
 * Parse an attribute as a JSON serialized object with a fallback
 *
 * @since 0.11.0
 * @param {T} fallback - fallback value
 * @returns {Parser<T, HTMLElement>} - parser function
 * @throws {ReferenceError} - if the value and fallback are both null or undefined
 * @throws {SyntaxError} - if the value is not a valid JSON object
 */
declare const asJSON: <T extends {}>(fallback: T) => AttributeParser<HTMLElement, T>;
export { asBoolean, asInteger, asNumber, asString, asEnum, asJSON };