Function: getArray()

getArray(obj, key): readonly unknown[] | undefined

Read an array property from an untrusted object as a readonly unknown[], or undefined.

The elements are left as unknown - callers narrow each one. A non-array (including a missing key) yields undefined, which callers treat as "no entries" rather than an error.

Parameters

obj

unknown

The source object (may be any unknown).

key

string

The property name to read.

Returns

readonly unknown[] | undefined

The array (elements untyped), or undefined when the key is missing or not an array.

Example

import { getArray } from "@cosyte/terminology";

getArray({ group: [{ source: "a" }] }, "group")?.length; // => 1