Interface ClassMethodDecoratorContext<This, Value>

Context provided to a class method decorator.

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 extends ((this, ...args) => any) = ((this, ...args) => any)

    The type of the decorated class method.

Hierarchy

  • ClassMethodDecoratorContext

Properties

access kind name private static

Methods

addInitializer

Properties

Readonly access

access: {
    get(object) => Value;
    has(object) => boolean;
}

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

Type declaration

  • get:function
    • get(object): Value

    • Gets the current value of the method from the provided object.

      Parameters

      • object: This

      Returns Value

      Example

      let fn = 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

      • object: This

      Returns boolean

Readonly kind

kind: "method"

The kind of class element that was decorated.

Readonly name

name: string | symbol

The name of the decorated class element.

Readonly private

private: boolean

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

Readonly static

static: boolean

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

Methods

addInitializer

  • 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) => void)
        • (this): void

        • Parameters

          • this: This

          Returns void

    Returns void

    Example

    const bound: ClassMethodDecoratorFunction = (value, context) {
      if (context.private) throw new TypeError("Not supported on private methods.");
      context.addInitializer(function () {
        this[context.name] = this[context.name].bind(this);
      });
    }

    class C {
      message = "Hello";
    @bound
      m() {
        console.log(this.message);
      }
    }

Settings

Member Visibility

Theme

On This Page