@poppinss/macroable/build/index.d.ts

Extend classes from outside in using Macros and getters

/**
 * Adds capabilities for extending the class from outside-in, in the form
 * of macros and getters.
 */
export default abstract class Macroable {
    /**
     *
     * Macros are standard properties that gets added to the class prototype.
     *
     * ```ts
     * MyClass.macro('foo', 'bar')
     * ```
     */
    static macro<T extends {
        new (...args: any[]): any;
    }, K extends keyof InstanceType<T>>(this: T, name: K, value: InstanceType<T>[K]): void;
    /**
     *
     * Getters are added to the class prototype using the Object.defineProperty.
     *
     * ```ts
     * MyClass.getter('foo', function foo () {
     *   return 'bar'
     * })
     * ```
     *
     * You can add a singleton getter by enabling the `singleton` flag.
     *
     * ```ts
     * const singleton = true
     *
     * MyClass.getter('foo', function foo () {
     *   return 'bar'
     * }, singleton)
     * ```
     */
    static getter<T extends {
        new (...args: any[]): any;
    }, K extends keyof InstanceType<T>>(this: T, name: K, accumulator: () => InstanceType<T>[K], singleton?: boolean): void;
}