shelving/util/lazy.d.ts

Toolkit for using data in JavaScript.

import type { Arguments } from "./function.js";
/**
 * Lazy value: a plain value, or an initialiser function that returns that value.
 * @param ...args Any arguments the lazy value needs if it's a function.
 */
export type Lazy<T, A extends Arguments = []> = ((...args: A) => T) | T;
/**
 * Initialise a lazy value.
 *
 * @param value The lazy value to resolve.
 * - If this is a plain value, that value is returned.
 * - If this is a function, it is called and its returned value is returned.
 *
 * @param ...args Any additional arguments the initialiser needs.
 * - This array of values is passed into the function or class constructor as its parameters.
 */
export declare function getLazy<T, A extends Arguments>(value: (...args: A) => T, ...args: A): T;
export declare function getLazy<T, A extends Arguments>(value: Lazy<T, A>, ...args: A): T;