@tanstack/ai/src/utilities/numbers.ts

Type-safe TypeScript AI SDK for streaming chat, tool calling, agents, structured outputs, and multimodal generation.

/**
 * Return the first candidate that is a finite `number`, or `undefined`.
 *
 * Handy for picking a value from among several possible spellings/sources where
 * only some are populated — e.g. the provider-native sampling option names read
 * by the OTel middleware, or the optional numeric fields on `TokenUsage`.
 */
export function firstNumber(...candidates: Array<unknown>): number | undefined {
  for (const candidate of candidates) {
    if (typeof candidate === 'number' && Number.isFinite(candidate)) {
      return candidate
    }
  }
  return undefined
}