Skip to content

Fix invalid decorator examples in lib.decorators.d.ts #64353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fatih Çakır (wfatih) wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −7
Open

Fix invalid decorator examples in lib.decorators.d.ts #64353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions tsc/internal/bundled/libs/lib.decorators.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,19 @@ interface ClassDecoratorContext<
*
* @example
* ```ts
* function customElement(name: string): ClassDecoratorFunction {
* return (target, context) => {
* function customElement(name: string) {
* return <Class extends CustomElementConstructor>(
* target: Class,
* context: ClassDecoratorContext<Class>,
* ) => {
* context.addInitializer(function () {
* customElements.define(name, this);
* });
* }
* };
* }
*
* @customElement("my-element")
* class MyElement {}
* class MyElement extends HTMLElement {}
* ```
*/
addInitializer(initializer: (this: Class) => void): void;
Expand Down Expand Up @@ -114,10 +117,14 @@ interface ClassMethodDecoratorContext<
*
* @example
* ```ts
* const bound: ClassMethodDecoratorFunction = (value, context) {
* function bound<This, Value extends (...args: any) => any>(
* value: Value,
* context: ClassMethodDecoratorContext<This, Value>,
* ) {
* if (context.private) throw new TypeError("Not supported on private methods.");
* context.addInitializer(function () {
* this[context.name] = this[context.name].bind(this);
* context.addInitializer(function (this: This) {
* const self = this as Record<PropertyKey, any>;
* self[context.name] = self[context.name].bind(this);
* });
* }
*
Expand Down