CyrefJS
CCyrefJS
EN
بازگشت به مستندات
نوع/از نسخه 1.38.0

isArray

بررسی می‌کند که آیا یک مقدار آرایه است یا نه و به‌عنوان type guard در TypeScript باعث narrow شدن نوع به آرایه می‌شود.

isArray(value):value is unknown[]

نحوه پیاده‌سازی

این تابع بررسی زمان اجرا را مستقیماً به Array.isArray() داخلی JavaScript واگذار می‌کند.

Type guard

نوع بازگشتی `value is unknown[]` است و باعث می‌شود تابع به‌عنوان TypeScript type guard عمل کند. پس از موفق بودن بررسی، TypeScript می‌تواند مقدار را در محدوده narrow شده به‌عنوان آرایه‌ای از عناصر unknown در نظر بگیرد.

رفتار در زمان اجرا

این بررسی آرایه‌های واقعی JavaScript، از جمله آرایه‌های خالی، را شناسایی می‌کند. آبجکت‌هایی که فقط ظاهری شبیه آرایه دارند false دریافت می‌کنند.

پارامترها

valueunknownالزامی

مقداری که باید بررسی شود.

مقدار بازگشتی

value is unknown[]

اگر مقدار آرایه باشد true و در غیر این صورت false برمی‌گرداند. در صورت true بودن، TypeScript نوع مقدار را به unknown[] محدود می‌کند.

مثال‌ها

01

استفاده پایه

بررسی اینکه یک مقدار آرایه است یا خیر.

TypeScript
isArray([1, 2, 3]);
// true

isArray("hello");
// false
02

Type narrowing

این تابع می‌تواند یک مقدار unknown را داخل یک شرط به unknown[] محدود کند.

TypeScript
const value: unknown = [1, 2, 3];

if (isArray(value)) {
  value.length;
  // value is narrowed to unknown[]
}
03

آرایه‌های خالی

آرایه‌های خالی نیز به‌عنوان آرایه شناسایی می‌شوند.

TypeScript
isArray([]);
// true
04

مقادیر دیگر

آبجکت‌ها، null، مقادیر primitive و سایر مقادیر غیرآرایه‌ای false برمی‌گردانند.

TypeScript
isArray({});
// false

isArray(null);
// false

isArray(42);
// false

isArray("hello");
// false
ساخته شده با@cyref/js·مستندات رسمی