Allow interface merging for DecoratorMetadataObject and parameterization by This

⚙ Compilation target

ESNext

⚙ Library

ESNext

Missing / Incorrect Definition

Currently DecoratorMetadataObject is defined as a type, however as metadata objects are intended to store values on behalf of user-defined decorators it would be useful to be able to specify more precise types for properties that such decorators add as metadata.

Sample Code

As an example, at current if we do:

const jsonFields = Symbol('jsonFields');

function field<This>(field: undefined, ctx: ClassFieldDecoratorContext<This>) {
    ctx.metadata[jsonFields] ??= [];
    // Object is of type 'unknown'.(2571)
    ctx.metadata[jsonFields].push(ctx.access.get);
}

function toJSON(obj: any) {
    // Get metadata from obj.constructor and process fields here
    // ...
}

class Foo {
    @field
    x: number = 3;
    @field 
    y: number = 4;
}

Then we get a fairly expected Object is of type 'unknown'.(2571) error.

However if allow declaration merging, then we can have better typing:

declare global {
    interface DecoratorMetadataObject {
        [jsonFields]?: Array<(this: object) => any>; 
    }
}

// Define decorator as before

If we further allow the metadata context to be parameterized with This, we can even allow even better typing:

declare global {
    interface DecoratorMetadataObject<This> {
        [jsonFields]?: Array<(this: This) => any>; 
    }
}

// define decorators...

class Foo {
    @field
    x = 3;
}

Foo[Symbol.metadata] // { [key: string]: unknown; [jsonFields]?: Array<(this: Foo) => any> }

This also helps detect conflicts if two libraries try to the use the same string-based decorator field:

// lib1
interface DecoratorMetadataObject {
    meta?: number;
}

function lib1Decorator() { /* ... */ }

// lib2
interface DecoratorMetadataObject {
    // Subsequent property declarations must have the same type.
    // Property 'meta' must be of type 'number | undefined', but here has type 'string | undefined'.(2717)
    meta?: string;
}


function lib2Decorator() { /* ... */ }

(and if TS adds type based metadata, it can give those appropriate types in the metadata object in the same way).

Documentation Link

No response