DocTypes

JSDoc generator for JavaScript, TypeScript using AI.

Sample

• Class

/**
 * Exporting the class User, which extends the class UserAbstract
 * and implements the interface PersonInterface.
 *
 * @class
 * @name User
 * @kind class
 * @extends UserAbstract
 * @implements PersonInterface
 * @exports
 */
export class User extends UserAbstract implements PersonInterface {}

• Function

/**
 * Exporting a function called `createUserId` that takes a parameter called `nonce`
 * that is a number and returns a value of type `Id`.
 *
 * @function
 * @name createUserId
 * @kind function
 * @param {number} nonce?
 * @returns {Id}
 * @exports
 */
export function createUserId(nonce: number = 0): Id {}

• Variable

/**
 * Generating a random number between the `MAX` and `MIN` variables.
 *
 * @constant
 * @name perfix
 * @kind variable
 * @memberof createUserId
 * @type {number}
 */
const perfix: number = Math.floor(Math.random() * (MAX - MIN)) + MIN;

• Interface

/**
 * Exporting the interface.
 *
 * @interface
 * @name PersonInterface
 * @kind interface
 * @exports
 */
export interface PersonInterface {}

• Type

/**
 * It's a type alias.
 *
 * @typedef
 * @name Id
 * @kind variable
 * @exports
 */
export type Id = string | number;

Shortcut keys

• linux shift+ctrl+/
• windows shift+ctrl+/
• mac shift+cmd+/

Configuration

Supported filetypes

• .js
• .ts

Test

• type.spec.ts
  • ✔ type Id
  • ✔ type Name
  • ✔ type Age
• interface.spec.ts
  • ✔ interface PersonInterface
  • ✔ id: Id
  • ✔ name?: Name
• abstract.spec.ts
  • ✔ abstract class UserAbstract
  • ✔ constructor()
  • ✔ abstract getAge()
  • ✔ abstract setAge(age: Age)
  • ✔ get isOld()
• class.spec.ts
  • ✔ class User extends UserAbstract implements PersonInterface
  • ✔ public readonly id: Id
  • ✔ public name?: Name
  • ✔ protected _age?: Age
  • ✔ constructor(id: Id, name?: Name)
  • ✔ set nickname(name: Name)
  • ✔ public getNickname: ()
  • ✔ public setAge(age: Age)
  • ✔ public getAge()
  • ✔ class Employee extends User
  • ✔ readonly role?: string
  • ✔ static department: string
  • ✔ public static createEmployee(id: Id) (54ms)
  • ✔ export default Employee
• variable.spec.ts
  • ✔ const MIN: 1111
  • ✔ const MAX: 999
• function.spec.ts
  • ✔ function createUserId(nonce: number = 0)
  • ✔ const perfix: number
  • ✔ function validateUserName<In extends string, Out = boolean>(username: In)
• index.spec.ts
  • ✔ const userId: Id
  • ✔ const john: User
  • ✔ john.getAge()

Note

Description values are generated by Mintlify AI.