Skip to content
masterclass Buddy

TypeScript · Interface

PromiseLike

TypeScript supports many JSDoc tags for adding type information to JavaScript. You can describe variables, function inputs and outputs, reusable object types, and callback types.

Last updated

Syntax

/** @type {Type} */
/** @param {Type} name */
/** @returns {Type} */
/** @typedef {object} Name */
/** @callback Name */

In-depth API docs are only for subscribers: parameters, examples, common mistakes and interview practice.

Subscribe
  • @type
  • @param
  • @returns
  • @typedef
  • @callback
  • @property
  • @template
  • @satisfies

Source: TypeScript: Documentation - JSDoc Reference. Checked 2026-11-03.