packagesutilspredicateisArray

isArray

값이 배열인지 확인하는 타입 가드 함수입니다.

Signatures

function isArray(value: unknown): value is any[];

Parameters

이름타입설명필수 여부
valueunknown검사할 값

Returns

boolean - 값이 배열이면 true, 아니면 false

Type Guard

이 함수는 TypeScript의 타입 가드로 동작합니다. 조건문에서 사용할 경우 value의 타입을 any[]로 좁혀줍니다.

사용 예시

import { isArray } from '@teamsparta/utils';
 
// 기본 사용
isArray([]); // true
isArray([1, 2, 3]); // true
isArray(['a', 'b', 'c']); // true
isArray([true, false, true]); // true
 
// 다른 타입의 값
isArray({}); // false
isArray(null); // false
isArray(undefined); // false
isArray(0); // false
isArray('string'); // false
isArray(new Date()); // false
isArray(() => {}); // false
 
// 타입 가드로 사용
const value: unknown = [1, 2, 3];
if (isArray(value)) {
  // 이 블록 안에서 value는 any[] 타입으로 추론됨
  const result: any[] = value; // 타입 에러 없음
}
 
// filter 메서드와 함께 사용
const mixedArray = ['abc', () => {}, [1, 2, 3]];
const arrayOnly = mixedArray.filter(isArray); // [[1, 2, 3]]
// arrayOnly의 타입은 any[][] 입니다