تعليقات أنواع JSDoc كجسر للترحيل

JSDoc كجسر إلى TypeScript

/** @type {string} */
let name = "Alice"; // TypeScript checks this as string

@param و@returns

/**
 * @param {string} name
 * @param {number} age
 * @returns {string}
 */
function greet(name, age) {
  return `${name} is ${age}`;
}

@typedef لأنواع الكائنات

/**
 * @typedef {Object} User
 * @property {string} id
 * @property {string} name
 * @property {boolean} isActive
 */

/** @type {User} */
const user = { id: "1", name: "Alice", isActive: true };

@template للأنواع العامة

/**
 * @template T
 * @param {T[]} arr
 * @returns {T | undefined}
 */
function first(arr) {
  return arr[0];
}
// TypeScript infers: first<T>(arr: T[]): T | undefined

استيراد الأنواع من ملفات .ts

/** @type {import("./types").User} */
const admin = { id: "admin", name: "Admin", isActive: true };

@ts-check للفحص حسب الملف

// @ts-check
/** @type {number} */
const count = "oops"; // Error: string not assignable to number

@ts-ignore و@ts-expect-error

// @ts-ignore
const x = badFunction(); // single error suppressed

// @ts-expect-error
const y = anotherBad(); // error expected here

تعدادات JSDoc

/** @enum {string} */
const Direction = { Left: "left", Right: "right", Up: "up" };

تأكيدات الأنواع في JSDoc

const el = /** @type {HTMLInputElement} */ (document.getElementById("input"));
el.value; // el: HTMLInputElement — typed

متى تنتقل إلى .ts

// Rename: utils.js → utils.ts
// Replace JSDoc: /** @param {string} x */ → (x: string)

مراجعة: JSDoc كجسر

تحقق سريع

ما تعلمته