UnwrapPromise

Since 1.3.0

Unwrap a Promise type to its inner value type. Returns the inner type if wrapped in Promise, otherwise returns the original type.

Signature

type UnwrapPromise<T> = T extends Promise<infer V> ? V : T

Parameters

Parameter	Description
T	The type to unwrap

Examples

Basic Usage

import type { UnwrapPromise } from 'uni-types'

type Value = UnwrapPromise<Promise<string>> // string

Non-Promise Type

import type { UnwrapPromise } from 'uni-types'

type Direct = UnwrapPromise<number> // number

With Async Functions

import type { UnwrapPromise } from 'uni-types'

async function fetchUser() {
  return { id: 1, name: 'John' }
}

type User = UnwrapPromise<ReturnType<typeof fetchUser>> // { id: number; name: string }

Related

• PromiseValue - Extract value recursively
• PromiseResult - Get resolved value (single level)