Parameters

Since 1.1.0

Get function parameters as a tuple type.

Signature

type Parameters<T> = T extends (...args: infer P) => any ? P : never

Parameters

Parameter	Description
T	The function type

Examples

Basic Usage

import type { Parameters } from 'uni-types'

type Fn = (a: string, b: number) => boolean
type Params = Parameters<Fn>  // [string, number]

With Functions

function greet(name: string, age: number) {
  return `Hello ${name}, you are ${age}`
}

type GreetParams = Parameters<typeof greet>
// [string, number]

Rest Parameters

type Variadic = (...args: string[]) => void
type Params = Parameters<Variadic>  // string[]

Related

• ReturnType - Get function return type
• NthParameter - Get Nth parameter