dynamic keys in jsdoc typedef

Question

Is it possible to have dynamic keys (prop names) in a jsdoc typedef? I'm imagining this would look something like the example below (which does not work).

@typedef {Object} Foo
@property {string} bar
@property {*} *

Passing properties not listed in the typedef e.g. {baz: 0} makes typescript upset with something like,

Argument of type '{ bar: string; baz: number; }' is not assignable to parameter of type 'Foo'. Object literal may only specify known properties, and 'baz' does not exist in type 'Foo'

Using the method proposed by @jcalz Object.<string, *> seems closer to the ideal output but resulted in a strange output

@typedef {Object} Foo
@property {number} bar
@property {Object.<string, *>}

output:

type Foo = {
    bar: number;
    (Missing): {
        [x: string]: any;
    };
}

Maybe use something like Object.<string, *> instead of Object, as mentioned here? — jcalz
– jcalz, Commented May 20, 2019 at 18:47
@jcalz, I wasn't able to make that work. I added the result to the post — J'e
– J'e, Commented May 21, 2019 at 12:34
Sorry, I've never really used JSDoc before. I was suggesting replacing Object in the first line with Object.<string, *>, and that works to add an index signature, but it breaks when you add bar. The only thing I have seen that works is /**@typedef { {[k: string]: any, bar: string } } Foo */, but that's basically just using TypeScript type syntax instead of JSDoc. — jcalz
– jcalz, Commented May 21, 2019 at 13:00

captain-yossarian from Ukraine · Accepted Answer · 2021-03-12 08:54:16Z

5

You can also use normal TS syntax in JSDOC.

See next example:

/**
 * 
 * @param {Record<string, string> & {bar:string}} arg
 */
const foo = (arg) => {}

You can even use utility types:

/**
 * 
 * @param {Partial<{age:number}>} arg 
 */
const partial = (arg) => { }

You can find more utils here

answered Mar 12, 2021 at 8:54

captain-yossarian from Ukraine

33.5k5 gold badges41 silver badges78 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

dynamic keys in jsdoc typedef

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related