Skip to content

FirstParameter ​

Since 1.0.0

Get the first parameter type of a function.

Signature ​

typescript
type FirstParameter<T> = T extends (first: infer F, ...rest: any[]) => any ? F : never

Parameters ​

ParameterDescription
TThe function type

Description ​

Extracts the type of the first parameter from a function type.

Examples ​

Basic Usage ​

typescript
import type { FirstParameter } from 'uni-types'

type Param = FirstParameter<(first: string, second: number) => void>
// string

Single Parameter ​

typescript
type SingleParam = FirstParameter<(value: number) => void>
// number

No Parameters ​

typescript
type NoParam = FirstParameter<() => void> // never

With Object Parameter ​

typescript
type ObjParam = FirstParameter<(options: { a: string; b: number }) => void>
// { a: string; b: number }

Released under the MIT License.