@ktjs/core 0.29.8 → 0.29.11

package/dist/reactive/ref.d.ts

@@ -1,89 +0,0 @@
-import { KTReactive, ReactiveChangeHandler } from '../types/reactive.js';
-import { KTReactiveType } from './core.js';
-export declare class KTRef<T> implements KTReactive<T> {
-    /**
-     * Indicates that this is a KTRef instance
-     */
-    isKT: true;
-    ktType: KTReactiveType;
-    /**
-     * @internal
-     */
-    private _value;
-    /**
-     * @internal
-     */
-    private _onChanges;
-    /**
-     * @internal
-     */
-    private _emit;
-    constructor(_value: T, _onChanges: Array<ReactiveChangeHandler<T>>);
-    /**
-     * If new value and old value are both nodes, the old one will be replaced in the DOM
-     */
-    get value(): T;
-    set value(newValue: T);
-    /**
-     * Force all listeners to run even when reference identity has not changed.
-     * Useful for in-place array/object mutations.
-     */
-    notify(): void;
-    /**
-     * Mutate current value in-place and notify listeners once.
-     *
-     * @example
-     * const items = ref<number[]>([1, 2]);
-     * items.mutate((list) => list.push(3));
-     */
-    mutate<R = void>(mutator: (currentValue: T) => R): R;
-    /**
-     * Register a callback when the value changes
-     * @param callback (newValue, oldValue) => xxx
-     */
-    addOnChange(callback: ReactiveChangeHandler<T>): void;
-    removeOnChange(callback: ReactiveChangeHandler<T>): boolean;
-}
-/**
- * Reference to the created HTML element.
- * - **Only** respond to `ref.value` changes, not reactive to internal changes of the element.
- * - can alse be used to store normal values, but it is not reactive.
- * - if the value is already a `KTRef`, it will be returned **directly**.
- * @param value mostly an HTMLElement
- */
-export declare function ref<T = JSX.Element>(value?: T, onChange?: ReactiveChangeHandler<T>): KTRef<T>;
-/**
- * Convert a value to `KTRef`.
- * - Returns the original value if it is already a `KTRef`.
- * - Throws error if the value is a `KTComputed`.
- * - Otherwise wraps the value with `ref()`.
- * @param o value to convert
- */
-export declare const toRef: <T = any>(o: any) => KTRef<T>;
-export type KTSurfaceRef<T extends object> = {
-    [K in keyof T]: KTRef<T[K]>;
-} & {
-    /**
-     * Get the dereferenced object like the original one
-     */
-    kcollect: () => T;
-};
-/**
- * Make all first-level properties of the object a `KTRef`.
- * - `obj.a.b` is not reactive
- */
-export declare const surfaceRef: <T extends object>(obj: T) => KTSurfaceRef<T>;
-/**
- * Assert k-model to be a ref object
- */
-export declare const $modelOrRef: <T = any>(props: any, defaultValue?: T) => KTRef<T>;
-type RefSetter<T> = (props: {
-    ref?: KTRef<T>;
-}, node: T) => void;
-/**
- * Whether `props.ref` is a `KTRef` only needs to be checked in the initial render
- */
-export declare const $initRef: <T extends Node>(props: {
-    ref?: KTRef<T>;
-}, node: T) => RefSetter<T>;
-export {};