npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-option-type

v3.1.1

Published

Rust inspired Option type - a union type wrapper of value T - Some<T> or None

Downloads

5

Readme

Option Type for Typescript

Option is a TypeScript utility that represents an optional value, which can either be Some wrapping a value or None. Use it to avoid the billion dollar mistake!

Table of Contents

Installation

Depending on your package manager, use one of the following commands:

npm

npm install ts-option-type

pnpm

pnpm add ts-option-type

yarn

yarn add ts-option-type

Tests

npm run test

Examples

1. Basic Usage

import { Some, None } from 'ts-option-type'

const maybeValue: Option<number> = Some(5)

const result = maybeValue.match(
    (value) => `Value is: ${value}`,
    () => "No value found"
)

console.log(result)  // Outputs: "Value is: 5"

2. Handling Defaults

const noValue: Option<string> = None

console.log(noValue.getValueOrDefault("Default String"))  // Outputs: "Default String"

3. Chaining Methods

const initialValue: Option<number> = Some(4)

const transformedValue = initialValue
    .map(value => value * 2)
    .filter(value => value > 5)

console.log(transformedValue.isSome)  // Outputs: true

4. Computation Fallbacks

const emptyValue: Option<string> = None

const result = emptyValue.getValueOrCompute(() => "Computed Value")

console.log(result)  // Outputs: "Computed Value"

5. Combining Multiple Options (set operations)

const first: Option<number> = Some(1)
const second: Option<number> = Some(2)

const combined = first.and(second)

console.log(combined === second)  // Outputs: true
console.log(None.and(first) === None)  // Outputs: true
console.log(None.or(first) === first)  // Outputs: true

6. Creation Patterns

Create and manipulate Option types using different patterns to fit various scenarios:

import { fromValue, fromValueConditional, fromNullable, fromUndefinable, createOptionFactory } from 'ts-option-type'

// 1. Convert any value to Option, treating null or undefined as None
const maybeValue = fromValue("Hello") // Some<string>

// 2. Convert a value to Option based on a custom condition
const isEmptyStr = (value: string) => value.length === 0
const maybeStr = fromValueConditional("", isEmptyStr) // None

// 3. Convert a possibly nullable object to Option
const nullObj: {} | null | undefined = null
const maybeObj = fromNullable(nullObj) // None - fromNullable(undefined) would have been Some!

// 4. Convert a possibly undefinable object to Option
const undefinedObj: {} | null | undefined = undefined
const maybeDef = fromUndefinable(undefinedObj) // None - fromUndefinable(null) would have been Some!

// 5. Create a custom Option factory using a predicate - when predicate is true, we get None
const isNegative = (value: number) => value < 0
const positiveNumberOptionFactory = createOptionFactory(isNegative)
const maybeNum = positiveNumberOptionFactory(5) // Some<number>

Testing

To run tests:

npm run test

License

This project is licensed under the MIT License - see the LICENSE file for details.