Interface ClassAccessorDecoratorContext<This, Value>

    Context provided to a class accessor field decorator.

    interface ClassAccessorDecoratorContext<This, Value> {
        access: {
            get(object: This): Value;
            has(object: This): boolean;
            set(object: This, value: Value): void;
        };
        kind: "accessor";
        metadata: DecoratorMetadataObject;
        name: string | symbol;
        private: boolean;
        static: boolean;
        addInitializer(initializer: ((this: This) => void)): void;
    }

    Type Parameters

    • This = unknown

      The type on which the class element will be defined. For a static class element, this will be the type of the constructor. For a non-static class element, this will be the type of the instance.

    • Value = unknown

      The type of decorated class field.

    Properties

    access kind metadata name private static

    Methods

    addInitializer

    Properties

    Readonlyaccess

    access: {
        get(object: This): Value;
        has(object: This): boolean;
        set(object: This, value: Value): void;
    }

    An object that can be used to access the current value of the class element at runtime.

    Type declaration

    • get:function
      • get(object): Value

      • Invokes the getter on the provided object.

        Parameters

        Returns Value

        Example

        let value = context.access.get(instance);
    • has:function
      • has(object): boolean

      • Determines whether an object has a property with the same name as the decorated element.

        Parameters

        Returns boolean

    • set:function
      • set(object, value): void

      • Invokes the setter on the provided object.

        Parameters

        Returns void

        Example

        context.access.set(instance, value);

    Readonlykind

    kind: "accessor"

    The kind of class element that was decorated.

    Readonlymetadata

    metadata: DecoratorMetadataObject

    Readonlyname

    name: string | symbol

    The name of the decorated class element.

    Readonlyprivate

    private: boolean

    A value indicating whether the class element has a private name.

    Readonlystatic

    static: boolean

    A value indicating whether the class element is a static (true) or instance (false) element.

    Methods

    addInitializer

    • addInitializer(initializer): void

    • Adds a callback to be invoked either before static initializers are run (when decorating a static element), or before instance initializers are run (when decorating a non-static element).

      Parameters

      • initializer: ((this: This) => void)
          • (this): void

          • Parameters

            Returns void

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods