Nullable

Since 1.0.0

Add null to a type.

Signature

type Nullable<T> = T | null

Parameters

Parameter	Description
T	The base type

Description

Creates a type that can be null. Useful for explicitly marking values that may be empty.

Examples

Basic Usage

import type { Nullable } from 'uni-types'

type Name = Nullable<string> // string | null

function greet(name: Nullable<string>) {
  if (name === null) {
    return 'Hello, stranger!'
  }
  return `Hello, ${name}!`
}

With Objects

interface User {
  id: number
  name: string
}

type MaybeUser = Nullable<User> // User | null

function findUser(id: number): MaybeUser {
  // May return User or null
  return null
}

Related

• Optional - Add undefined to a type
• Maybe - Add null/undefined to a type
• NonNullable - Exclude null/undefined