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
• Examples
• Testing
• License

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

1import { Some, None } from 'ts-option-type'
2
3const maybeValue: Option<number> = Some(5)
4
5const result = maybeValue.match(
6    (value) => `Value is: ${value}`,
7    () => "No value found"
8)
9
10console.log(result)  // Outputs: "Value is: 5"

2. Handling Defaults

1const noValue: Option<string> = None
2
3console.log(noValue.getValueOrDefault("Default String"))  // Outputs: "Default String"

3. Chaining Methods

1const initialValue: Option<number> = Some(4)
2
3const transformedValue = initialValue
4    .map(value => value * 2)
5    .filter(value => value > 5)
6
7console.log(transformedValue.isSome)  // Outputs: true

4. Computation Fallbacks

1const emptyValue: Option<string> = None
2
3const result = emptyValue.getValueOrCompute(() => "Computed Value")
4
5console.log(result)  // Outputs: "Computed Value"

5. Combining Multiple Options (set operations)

1const first: Option<number> = Some(1)
2const second: Option<number> = Some(2)
3
4const combined = first.and(second)
5
6console.log(combined === second)  // Outputs: true
7console.log(None.and(first) === None)  // Outputs: true
8console.log(None.or(first) === first)  // Outputs: true

6. Creation Patterns

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

1import { fromValue, fromValueConditional, fromNullable, fromUndefinable, createOptionFactory } from 'ts-option-type'
2
3// 1. Convert any value to Option, treating null or undefined as None
4const maybeValue = fromValue("Hello") // Some<string>
5
6// 2. Convert a value to Option based on a custom condition
7const isEmptyStr = (value: string) => value.length === 0
8const maybeStr = fromValueConditional("", isEmptyStr) // None
9
10// 3. Convert a possibly nullable object to Option
11const nullObj: {} | null | undefined = null
12const maybeObj = fromNullable(nullObj) // None - fromNullable(undefined) would have been Some!
13
14// 4. Convert a possibly undefinable object to Option
15const undefinedObj: {} | null | undefined = undefined
16const maybeDef = fromUndefinable(undefinedObj) // None - fromUndefinable(null) would have been Some!
17
18// 5. Create a custom Option factory using a predicate - when predicate is true, we get None
19const isNegative = (value: number) => value < 0
20const positiveNumberOptionFactory = createOptionFactory(isNegative)
21const 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.