Implement the Stage 3 Decorators Proposal #50820
Split out decorators types from the default lib
- Loading branch information
commit fdfb49c9652af520095c4bcde4a910d25a601700
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| /** | ||
| * Context provided to a class decorator. | ||
| */ | ||
| interface ClassDecoratorContext<Class extends abstract new (...args: any[]) => any> { | ||
| readonly kind: "class"; | ||
| readonly name: string | undefined; | ||
|
|
||
| /** | ||
| * Adds a callback to be invoked after the class definition has been finalized. | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * function customElement(name: string): ClassDecoratorFunction { | ||
| * return (target, { addInitializer }) => { | ||
| * addInitializer(function () { | ||
| * customElements.define(name, this); | ||
| * }); | ||
| * } | ||
| * } | ||
| * | ||
| * @customElement("my-element") | ||
| * class MyElement {} | ||
| * ``` | ||
| */ | ||
| addInitializer(initializer: (this: Class) => void): void; | ||
| } | ||
|
|
||
| /** | ||
| * Describes a function that can be used to decorate a class. | ||
| */ | ||
| type ClassDecoratorFunction = < | ||
| In extends abstract new (...args: any[]) => any, | ||
| Out extends abstract new (...args: any[]) => any = In, | ||
| Class extends abstract new (...args: any[]) => any = Out | ||
| >(target: In, context: ClassDecoratorContext<Class>) => Out | void; | ||
|
|
||
| /** | ||
| * Context provided to a class method decorator. | ||
| */ | ||
| interface ClassMethodDecoratorContext<This, Value extends (this: This, ...args: any[]) => any> { | ||
| readonly kind: "method"; | ||
| readonly name: string | symbol; | ||
| readonly static: boolean; | ||
| readonly private: boolean; | ||
| readonly access: { | ||
| /** | ||
| * Gets the current value of the method from the provided receiver. | ||
| * | ||
| * @example | ||
| * let fn = context.access.get.call(instance); | ||
| */ | ||
| get(this: This): Value; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds a callback to be invoked either before static initializers are run (when | ||
| * decorating a `static` member), or before instance initializers are run (when | ||
| * decorating a non-`static` member). | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * const bound: ClassMethodDecoratorFunction = (value, { name, private: isPrivate, addInitializer }) { | ||
| * if (isPrivate) throw new TypeError("Not supported on private methods."); | ||
| * addInitializer(function () { | ||
| * this[name] = this[name].bind(this); | ||
| * }); | ||
| * } | ||
| * | ||
| * class C { | ||
| * message = "Hello"; | ||
| * | ||
| * @bound | ||
| * m() { | ||
| * console.log(this.message); | ||
| * } | ||
| * } | ||
| * ``` | ||
| */ | ||
| addInitializer(initializer: (this: This) => void): void; | ||
| } | ||
|
|
||
| /** | ||
| * Describes a function that can be used to decorate a class method. | ||
| */ | ||
| type ClassMethodDecoratorFunction<Traits extends { name?: string | symbol, static?: boolean, private?: boolean } = {}> = < | ||
| This, | ||
| In extends (this: This, ...args: any[]) => any, | ||
| Out extends (this: This, ...args: any[]) => any = In, | ||
| Value extends (this: This, ...args: any[]) => any = Out | ||
| >(target: In, context: ClassMethodDecoratorContext<This, Value> & Readonly<Pick<Traits, "name" | "static" | "private">>) => Out | void; | ||
|
|
||
| /** | ||
| * Context provided to a class `get` method decorator. | ||
| */ | ||
| interface ClassGetterDecoratorContext<This, Value> { | ||
| readonly kind: "getter"; | ||
| readonly name: string | symbol; | ||
| readonly static: boolean; | ||
| readonly private: boolean; | ||
| readonly access: { | ||
| /** | ||
| * Invokes the getter on the provided receiver. | ||
| * | ||
| * @example | ||
| * let value = context.access.get.call(instance); | ||
| */ | ||
| get(this: This): Value; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds a callback to be invoked either before static initializers are run (when | ||
| * decorating a `static` member), or before instance initializers are run (when | ||
| * decorating a non-`static` member). | ||
| */ | ||
| addInitializer(initializer: (this: This) => void): void; | ||
| } | ||
|
|
||
| /** | ||
| * Describes a function that can be used to decorate a class `get` method. | ||
| */ | ||
| type ClassGetterDecoratorFunction = < | ||
| This, | ||
| In, | ||
| Out = In, | ||
| Value = Out, | ||
| >(target: { get(this: This): In }, context: ClassGetterDecoratorContext<This, Value>) => { get(this: This): Out; } | void; | ||
|
|
||
| /** | ||
| * Context provided to a class `set` method decorator. | ||
| */ | ||
| interface ClassSetterDecoratorContext<This, Value> { | ||
| readonly kind: "setter"; | ||
| readonly name: string | symbol; | ||
| readonly static: boolean; | ||
| readonly private: boolean; | ||
| readonly access: { | ||
| /** | ||
| * Invokes the setter on the provided receiver. | ||
| * | ||
| * @example | ||
| * context.access.set.call(instance, value); | ||
| */ | ||
| set(this: This, value: Value): void; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds a callback to be invoked either before static initializers are run (when | ||
| * decorating a `static` member), or before instance initializers are run (when | ||
| * decorating a non-`static` member). | ||
| */ | ||
| addInitializer(initializer: (this: This) => void): void; | ||
| } | ||
|
|
||
| /** | ||
| * Describes a function that can be used to decorate a class `set` method. | ||
| */ | ||
| type ClassSetterDecoratorFunction = < | ||
| This, | ||
| In, | ||
| Out = In, | ||
| Value = Out | ||
| >(target: { set(this: This, value: In): void; }, context: ClassSetterDecoratorContext<This, Value>) => { set(this: This, value: Out): void; } | void; | ||
|
|
||
| /** | ||
| * Context provided to a class `accessor` field decorator. | ||
| */ | ||
| interface ClassAccessorDecoratorContext<This, Value> { | ||
| readonly kind: "accessor"; | ||
| readonly name: string | symbol; | ||
| readonly static: boolean; | ||
| readonly private: boolean; | ||
| readonly access: { | ||
| /** | ||
| * Invokes the getter on the provided receiver. | ||
| * | ||
| * @example | ||
| * let value = context.access.get.call(instance); | ||
| */ | ||
| get(this: This): Value; | ||
|
|
||
| /** | ||
| * Invokes the setter on the provided receiver. | ||
| * | ||
| * @example | ||
| * context.access.set.call(instance, value); | ||
| */ | ||
| set(this: This, value: Value): void; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds a callback to be invoked either before static initializers are run (when | ||
| * decorating a `static` member), or before instance initializers are run (when | ||
| * decorating a non-`static` member). | ||
| */ | ||
| addInitializer(initializer: (this: This) => void): void; | ||
| } | ||
|
|
||
| /** | ||
| * Describes a function that can be used to decorate a class `accessor` field. | ||
| */ | ||
| type ClassAccessorDecoratorFunction = < | ||
| This, | ||
| In, | ||
| Out = In, | ||
| Value = Out | ||
| >( | ||
| target: { get(this: This): In; set(this: This, value: In): void; }, | ||
| context: ClassAccessorDecoratorContext<This, Value> | ||
| ) => { get?(this: This): Out; set?(this: This, value: Out): void; init?(this: This, value: In): Out; } | void; | ||
|
|
||
| /** | ||
| * Context provided to a class field decorator. | ||
| */ | ||
| interface ClassFieldDecoratorContext<This, Value> { | ||
| readonly kind: "field"; | ||
| readonly name: string | symbol; | ||
| readonly static: boolean; | ||
| readonly private: boolean; | ||
| readonly access: { | ||
| /** | ||
| * Gets the value of the field on the provided receiver. | ||
| */ | ||
| get(this: This): Value; | ||
|
|
||
| /** | ||
| * Sets the value of the field on the provided receiver. | ||
| */ | ||
| set(this: This, value: Value): void; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds a callback to be invoked either before static initializers are run (when | ||
| * decorating a `static` member), or before instance initializers are run (when | ||
| * decorating a non-`static` member). | ||
| */ | ||
| addInitializer(initializer: (this: This) => void): void; | ||
| } | ||
|
|
||
| /** | ||
| * Describes a function that can be used to decorate a class field. | ||
| */ | ||
| type ClassFieldDecoratorFunction = < | ||
| This, | ||
| In, | ||
| Out = In, | ||
| Value = Out | ||
| >(target: undefined, context: ClassAccessorDecoratorContext<This, Value>) => ((this: This, initialValue: In) => Out) | void; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void; | ||
| declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void; | ||
| declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void; | ||
| declare type ParameterDecorator = (target: Object, propertyKey: string | symbol, parameterIndex: number) => void; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| interface ParameterDecoratorContext<Func extends Function> { | ||
| readonly kind: "parameter"; | ||
| readonly index: number; | ||
| readonly name: string | undefined; | ||
| readonly rest: boolean; | ||
| addInitializer(initializer: (this: Func) => void): void; | ||
| } | ||
|
|
||
| type ParameterDecoratorFunction = < | ||
| Func extends Function, | ||
| This, | ||
| In, | ||
| Out = In | ||
| >(target: undefined, context: ParameterDecoratorContext<Func>) => ((this: This, initialValue: In) => Out) | void; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.