taggedjs/js/tag/tag.d.ts

tagged template reactive html

import { KeyFunction } from './getDomTag.function.js';
import type { StringTag } from './StringTag.type.js';
import type { DomTag } from './DomTag.type.js';
import { Original } from './tag.utils.js';
import { RouteProps, RouteTag, StateToTag, ToTag } from './tag.types.js';
import { UnknownFunction } from './update/oneRenderToSupport.function.js';
/** TODO: This might be a duplicate typing of Wrapper */
export type TaggedFunction<T extends ToTag> = ((...x: Parameters<T>) => ReturnType<T> & {
    key: KeyFunction;
    original?: Original;
    compareTo?: string;
}) & {
    original: UnknownFunction;
};
export declare enum PropWatches {
    DEEP = "deep",
    SHALLOW = "shallow",
    NONE = "none",
    IMMUTABLE = "immutable"
}
/** Wraps a function tag in a state manager and calls wrapped function on event cycles
 * For single rendering, no event cycles, use: tag.renderOnce = (props) => html``
 */
export declare function tag<T extends ToTag>(tagComponent: T, propWatch?: PropWatches): TaggedFunction<T>;
export declare namespace tag {
    /** @deprecated use "use" instead */
    let state: typeof tagUseFn;
    /** Used to declare a function has state in the form of a function, that when called, returns content for rendering
     * Example () => tag.use = (counter = 0)
     */
    let use: typeof tagUseFn;
    /** Used to create a tag component that renders once and has no addition rendering cycles */
    let renderOnce: typeof renderOnceFn;
    let route: typeof routeFn;
    let app: (_routeTag: RouteTag) => StateToTag;
    let deepPropWatch: typeof tag;
    let immutableProps: <T extends ToTag>(tagComponent: T) => TaggedFunction<T>;
    let watchProps: <T extends ToTag>(tagComponent: T) => TaggedFunction<T>;
}
type ReturnTag = DomTag | StringTag | StateToTag | null | undefined;
declare function renderOnceFn(): ReturnTag;
/** Used to create variable scoping when calling a function that lives within a prop container function */
declare function tagUseFn(): ReturnTag;
declare function routeFn(_routeProps: RouteProps): StateToTag;
export {};