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

UIElement - a HTML-first library for reactive Web Components

import type { AttributeParser } from '../component'
/**
 * Parse a boolean attribute as an actual boolean value
 *
 * @since 0.13.1
 * @returns {AttributeParser<boolean>}
 */
declare const asBoolean: () => AttributeParser<boolean>
/**
 * Parse an attribute as as number forced to integer with a fallback
 *
 * Supports hexadecimal and scientific notation
 *
 * @since 0.11.0
 * @param {number} [fallback=0] - fallback value
 * @returns {AttributeParser<number>} parser function
 */
declare const asInteger: (fallback?: number) => AttributeParser<number>
/**
 * Parse an attribute as as number with a fallback
 *
 * @since 0.11.0
 * @param {number} [fallback=0] - fallback value
 * @returns {AttributeParser<number>} parser function
 */
declare const asNumber: (fallback?: number) => AttributeParser<number>
/**
 * Parse an attribute as a string with a fallback
 *
 * @since 0.11.0
 * @param {string} [fallback=''] - fallback value
 * @returns {AttributeParser<string>} parser function
 */
declare const asString: (fallback?: string) => AttributeParser<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 {AttributeParser<string>} parser function
 */
declare const asEnum: (valid: [string, ...string[]]) => AttributeParser<string>
/**
 * Parse an attribute as a JSON serialized object with a fallback
 *
 * @since 0.11.0
 * @param {T} fallback - fallback value
 * @returns {AttributeParser<T>} 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<T>
export { asBoolean, asInteger, asNumber, asString, asEnum, asJSON }