Skip to main content
Version: v0.0.2

Function: getNumber()

getNumber(obj, key): number | undefined

Read a number property from an untrusted object, or undefined if absent/not a finite number.

Parameters

obj

unknown

The source object (may be any unknown).

key

string

The property name to read.

Returns

number | undefined

The number value, or undefined when the key is missing or not a finite number.

Example

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

getNumber({ valueInteger: 3 }, "valueInteger"); // => 3