Typescript Option

Rust options for typescript

⚙️ Installation

Here i'm using pnpm but you can use any package manager you prefer.

$ pnpm i typescript-option -S

🛠️ Api

❓ Helper functions to help you deal with options

• wrap
• some
• none

Option

⚡ All functions you can call on an option

• unwrap
• unwrap_or
• unwrap_or_else
• run
• transform
• map
• map_or
• map_or_else

📖 Types

📌 All types available

• Option
• Some
• None

🎯 Features

🚀 Checkout some examples

• wrap: Wraps any value in an Option<T>

• some: Checks if any value is Some<T>

• none: Checks if any value is None

• unwrap: Unwraps an Option<T> into either T or false

• unwrap_or: Uwraps an Option<T> into T or, a default value T

• unwrap_or_else: Uwraps an Option<T> into T or, a default function that returns T

• run: Used to call functions that use an Option<T>

• transform: Used to call functions that will apply a transformation to an Option<T>

• map: Used to call functions that takes the internal type of an Option<T> and returns an Option<U>

• map_or: Used to call functions that takes the internal type of an Option<T> and returns an Option<U> or return U, if Option<T> was None

• map_or: Used to call functions that takes the internal type of an Option<T> and returns an Option<U> or call an funtion returning U, if Option<T> was None

• Option: A type to that represent either the existance of something or nothing

• Some: A type to that represent some value

• None: A type to that represent nothing

Examples

function getUserPlan(userId: string): Option<UserPlan> { ... }

function getJwtPayload(token: string): Option<JwtPayload> { ... }

const token = wrap(cookies.get("access-token"))

const plan = token
    .map(getJwtPayload)
    .map((payload) => getUserPlan(payload.userId))
    .run(sendUserPlanEmail)
    .unwrap()

// Plan will be either Some<UserPlan> or None