JSDoc @param as a predefined constant object

Question

Let's say I have a predefined constant object like this:

const person = {
   name: "",
   gender: "",
   age: 0
}

Then I have a function that requires the parameter must be the type of person:

/**
 * @param {*} personObj How can we enforce the personObj as the type of an existing constant object?
 */
function approve(personObj) {

}

How can I enforce the personObj to be the type of person? Is it possible to avoid using @typedef? Because I have many predefined constant objects of such that we do not want to rewrite all the definitions again. Any advice would be appreciated, thank you!

Amir Saleem · Accepted Answer · 2021-06-21 07:05:44Z

2

You can achieve this with 2 different approaches:

Define the types in jsdoc comments as follows

/**
 * @param { { name: string, gender: string, age: number } } personObj Person Object
 */
function approve(personObj) {
   // do stuff with personObj
}

All the popular Editors and IDE's will show the above-mentioned comments in a formatted way.

Write a module.d.ts file

You can also add a declaration file that defines all the type definitions used inside a module.

Create a module.d.ts file and declare your Module

// module.d.ts

export interface Person {
  name: string;
  gender: string;
  age: number
}

Your code editor will use this declaration file to provide you with the hints and checks you need in your code.

More about declaration files here

edited Jun 21, 2021 at 7:05

answered Jun 21, 2021 at 6:59

Amir Saleem

3,1604 gold badges25 silver badges36 bronze badges

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

2 Comments

Antonio Ooi Over a year ago

Sorry, is this type script? I never use typescript before. If my node.js project has not been setup for typescript, can I still use approach #2? In module.d.ts, what is d stands for? Can it be anything?

Amir Saleem Over a year ago

Yes, this is typescript file, The purpose of declaration files is to introduce types in javascript code. d stands for declaration. you can name your file anything as *.d.ts where asterisk can be replaced by your module name. You need to use namespace declarations. You can follow the link I've added to look into ts docs

viswa · Accepted Answer · 2021-06-21 06:46:12Z

0

You can try something like this

/**
 * @param {Object<name:string,gender:string,age:number>} personObj 
 */

function approve(personObj) {

}

answered Jun 21, 2021 at 6:46

viswa

11 bronze badge

1 Comment

Antonio Ooi Over a year ago

Ya, I'm aware of this, but if I have many functions that make use of Person parameter, then I'll have to rewrite the definition as @param for all the functions. Any change of structure needs to change the JSDoc for all functions again...

Collectives™ on Stack Overflow

JSDoc @param as a predefined constant object

2 Answers 2

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related