Skip to content

How to describe interface with properties? #280

@VityaSchel

Description

@VityaSchel

If I have an interface

interface Dog {
  name: string
  age: number
}

How to document it with JSDoc so this lib can parse it?

My failed attempt was

/**
 * An animal, human friend
 * @interface Dog
 * @property {string} name
 * @property {number} age
 * @memberof module:modulename
 */
interface Dog {
  name: string
  age: number
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions