RequireArray

Since 1.3.0

Ensure type is an array.

Signature

type RequireArray<T> = T extends unknown[] ? T : never

Parameters

Parameter	Description
T	The type to check

Examples

Basic Usage

import type { RequireArray } from 'uni-types'

type Result = RequireArray<string[]> // string[]
type Failed = RequireArray<string> // never

With Union Types

type MaybeArray = string[] | number
type OnlyArray = RequireArray<MaybeArray> // string[]

With Readonly Arrays

type ReadonlyStrings = readonly string[]
type Result = RequireArray<ReadonlyStrings> // readonly string[]

Related

• RequireFunction - Ensure type is a function
• RequireNotNullish - Ensure type is not null or undefined