(self: unknown): self is Array<unknown>
<T>(self: T): self is Extract<T, ReadonlyArray<any>>Checks whether a value is an Array.
When to use
Use to verify a value is a mutable array, narrowing its type to Array<unknown>.
Details
Acts as a type guard narrowing the input to Array<unknown> and delegates to
globalThis.Array.isArray.
Example (Type-guarding an unknown value)
import { Array } from "effect"
console.log(Array.isArray(null)) // false
console.log(Array.isArray([1, 2, 3])) // trueexport const const isArray: {
(self: unknown): self is Array<unknown>
<T>(self: T): self is Extract<
T,
ReadonlyArray<any>
>
}
Checks whether a value is an Array.
When to use
Use to verify a value is a mutable array, narrowing its type to Array<unknown>.
Details
Acts as a type guard narrowing the input to Array<unknown> and delegates to
globalThis.Array.isArray.
Example (Type-guarding an unknown value)
import { Array } from "effect"
console.log(Array.isArray(null)) // false
console.log(Array.isArray([1, 2, 3])) // true
isArray: {
(self: unknownself: unknown): self: unknownself is interface Array<T>Array<unknown>
<function (type parameter) T in <T>(self: T): self is Extract<T, ReadonlyArray<any>>T>(self: Tself: function (type parameter) T in <T>(self: T): self is Extract<T, ReadonlyArray<any>>T): self: Tself is type Extract<T, U> = T extends U
? T
: never
Extract from T those types that are assignable to U
Extract<function (type parameter) T in <T>(self: T): self is Extract<T, ReadonlyArray<any>>T, interface ReadonlyArray<T>ReadonlyArray<any>>
} = const Array: ArrayConstructorExposes the global array constructor.
When to use
Use to access native JavaScript array constructor methods such as isArray
or from from the Effect module namespace.
Example (Accessing the Array constructor)
import { Array } from "effect"
const arr = new Array.Array(3)
console.log(arr) // [undefined, undefined, undefined]
Array.ArrayConstructor.isArray(arg: any): arg is any[]isArray