@typescript-package/wrapped-descriptor/lib/wrapped-descriptor-base.abstract.d.ts

A lightweight TypeScript library for wrapped property descriptor.

import { WrappedDescriptorCore } from './wrapped-descriptor-core.abstract';
import { WrappedPropertyDescriptor } from '@typedly/descriptor';
import { GetterCallback, SetterCallback } from '@typedly/callback';
/**
 * @description The base abstraction class for wrapped descriptors.
 * @export
 * @abstract
 * @class WrappedDescriptorBase
 * @template [O=any] The type of the object to define the descriptor on.
 * @template {keyof O} [K=keyof O] The key of the object to define the descriptor on.
 * @template {K extends keyof O ? O[K] : any} [V=K extends keyof O ? O[K] : any] The value type of the key in the object.
 * @template {boolean} [A=boolean] The type of active.
 * @template {boolean} [N=boolean] The type of enabled.
 * @template {boolean} [C=boolean] The type of configurable.
 * @template {boolean} [E=boolean] The type of enumerable.
 * @template {WrappedDescriptorBase<O, K, V, A, N, C, E, D> | PropertyDescriptor} [D=WrappedDescriptorBase<O, K, V, A, N, C, E, any>]
 * @extends {WrappedDescriptorCore<O, K, V, A, N, C, E, D>}
 */
export declare abstract class WrappedDescriptorBase<O = any, K extends keyof O = keyof O, V extends K extends keyof O ? O[K] : any = K extends keyof O ? O[K] : any, A extends boolean = boolean, N extends boolean = boolean, C extends boolean = boolean, E extends boolean = boolean, D extends WrappedDescriptorBase<O, K, V, A, N, C, E, D> | PropertyDescriptor = WrappedDescriptorBase<O, K, V, A, N, C, E, any>> extends WrappedDescriptorCore<O, K, V, A, N, C, E, D> {
    #private;
    /**
     * @inheritdoc
     */
    get active(): A | {
        onGet?: boolean | undefined;
        onSet?: boolean | undefined;
    };
    /**
     * @inheritdoc
     */
    get enabled(): N;
    /**
     * @inheritdoc
     */
    get index(): number | undefined;
    /**
     * @inheritdoc
     */
    get key(): K;
    /**
     * @inheritdoc
     */
    get onGet(): GetterCallback<O, K> | undefined;
    /**
     * @inheritdoc
     */
    get onSet(): SetterCallback<O, K> | undefined;
    /**
     * @inheritdoc
     */
    get previousDescriptor(): D | undefined;
    /**
     * @inheritdoc
     */
    get privateKey(): PropertyKey;
    /**
     * Creates an instance of `WrappedDescriptorBase` child class.
     * @constructor
     * @param {O} object The object to define the descriptor on.
     * @param {K} key The key of the object to define the descriptor on.
     * @param {Partial<WrappedPropertyDescriptor<O, K, V, A, N, C, E, D>>} [attributes={}] The property descriptor attributes.
     */
    constructor(object: O, key: K, attributes?: Partial<WrappedPropertyDescriptor<O, K, V, A, N, C, E, D>>);
    /**
     * @inheritdoc
     * @public
     * @returns {WrappedPropertyDescriptor<O, K, V, A, N, C, E, D>}
     */
    valueOf(): WrappedPropertyDescriptor<O, K, V, A, N, C, E, D>;
}