option-t

49.0.1 • Public • Published

option-t

npm CI on main branch

  • This library provides a toolkit for nullable types in ECMAScript.
  • APIs are inspired by Rust Language's Option<T> and Result<T, E>.
  • This library helps to sort the "nullable" convention in your project.
  • TypeScript friendly APIs.
    • We recommend to use this with some static type systems like TypeScript.
  • Zero dependency.
    • We use only a pure ECMAScript feature to implement this library as possible except a packaging system or a legacy module system.
    • This library is designed to be portable to any host environments supporting a set of ECMAScript features which we use, at implementation code level (not at packaging level).
    • We might provide a feature using host defined facilities but they would be a opt-in.
  • Tree shakable completely.
  • ES Module first.
    • Of course, we provide CommonJS too for backward compatibility.
  • Enable to use with a programming styles that mixes an execution context between server and client across the boundary (e.g. Qwik).

Motivation

This library provides these conventions for your project:

  1. Uniform an expression of "none" value in JavaScript.
  2. Uniform a way to carry error information instead of throwing an error by result type.
  3. Provide various utility functions to handle 1 and 2 easily.

And Rust's std::option and std::result are suggestive to achieve these conventions in practice. Thus this package is inspired by their design.

Uniform the expression of "none" value.

In JavaScript world, there are many ways to express "there is no value". At least in ECMA262, There are some ways to represent them:

  • undefined (e.g. Map.prototype.get())
  • null (e.g. RegExp.prototype.exec())
  • -1 (e.g. String.prototype.indexOf())

In addition, ECMA262 interacts with DOM binding, Node.js standard modules, and others. There are additional various ways to represent "none" value.

In practice, we write some glue code to tame their various ways in our project to uniform their expression style. This library contributes to uniform the convention to write it.

Uniform the way to carry error information instead of throwing an error.

Exception is useful but it has some terrible aspects. It's easy that try-catch statement to be a jump instruction by large scoped try-catch statement. It's hard to find where to throw an error, it's also hard to handle a penetrated exception from a lower layer. Especially, exception mechanism mis-matches with an async programming model. ECMA262 7th' async-await relaxes the problem about an exception with async programming, but there is still the problem about exceptions in traditional synchronous programming. Furthermore, if you interact with setTimeout() and other async APIs built with callback style on event loop, this problem faces you.

And some async-push based paradigm like Rx.Observable<T> does not allow throw any exceptions in their Observable stream. If you throw an error in it, only catch() operator can catch the error. But a programmer would sometimes forget to use its operator. This means that throwing an Error in Rx's Observable is pretty mis-matched action. Promise also has a similar problem.

And exception in ECMA262 is not friendly with static typing model because ECMA262's throw can throw not only Error but also other object types.

In Rust which is a programming language designed for parallel and seftiness, it treats errors in two category:

Rust groups errors into two major categories: recoverable and unrecoverable errors. For a recoverable error, such as a file not found error, it’s reasonable to report the problem to the user and retry the operation. Unrecoverable errors are always symptoms of bugs, like trying to access a location beyond the end of an array.

This categorization is pretty useful to relax the problem about exception in ECMA262 which this section described.

Thus this library provides a way to express recoverable error and also recommends to use throwing an error only if you intend to throw an unrecoverable error. This categorization introduces a convenient convention for you:

  • If the code uses throw, you should be careful about unrecoverable error.
  • If the code returns Result<T, E> provided this library, then you should handle it correctly.

This convention is clear as error handling style and it's static typing friendly by generics.

Provide a utility function to handle these uniformed expression easily.

Some static type checking tools also provide a way to check nullability and provide these conventions.

Flowtype and TypeScript checks with their control flow analysis (Sorry, I'm not sure about the details of Google Closure Compiler's behavior).

However, these compilers do not provide a way to handle their value easily like map or flatMap operations.

Rust's std::option and std::result have some utility operation methods to handle them easily. This library also provides a convenient way to handle them and its way is inspired by Rust's ones.

Supported Environments

We target to run in following environments.

  • Language
  • Module system
    • ES Module (ES2020 level).
    • CommonJS
    • A runtime environment or module bundler must support Node.js' package.json's exports field (Newer is better).
      • We require TypeScript's --moduleResolution is set as node16, bundler, or others that supports exports field if your project use TypeScript.

Caution

  1. Your code may work with this package even if your project does not supports all of these requirements. But we may not be able to support such environments officially. We recommend to update your environment generally.
  2. If you would like to work this packages for a more legacy environment (e.g. ES2016 or earlier) we recommend to transform whole of codes including your dependencies in your build pipeline.
    • If you need to support ES5 environment, you can use v37 too.
  3. If your project still use TypeScript's --moduleResolution with node/node10 setting, please use v35.

Installation

npm install --save option-t

# If you need to supports an environment that does not support ES2017
# without any transform whole of programs including dependencies.
npm install --save option-t@^37

# If your project still...
#   1. Use TypeScript with `--moduleResolution node` or `--moduleResolution node10` setting.
#   2. Or use some other tools that does not support Node.js's package.json's `exports` field.
#       - For example, `eslint-plugin-import@2.27.5`'s `import/no-unresolved` rule would be affected.
npm install --save option-t@^35

Usage & APIs

All APIs are TypeScript ready.

Additional documents are in docs/.

How to import

Examples

// Import functions and types which you would like to use:
import { type Maybe } from 'option-t/maybe';
import { type Nullable, isNotNull } from 'option-t/nullable';
import { type Undefinable } from 'option-t/undefinable';
import { type Result, createOk, isOk } from 'option-t/plain_result';
// You can also use `<TypeName>.<operatorName>`
import { Nullable } from 'option-t/nullable/namespace';

declare let numberOrNull: Nullable.Nullable<number>;
// IntelliSense can suggest and narrow down by the order of Type -> related operations.
const some = Nullable.unwrapOr(numberOrNull, -1);
// You can import only a specific function by the more detailed path.
import { type Nullable, unwrapNullable } from 'option-t/nullable/nullable';
import { unwrapOrForNullable } from 'option-t/nullable/unwrap_or';

See also

You can use these paths in both of CommonJS style and ES Module style. This package provides some sub directories to import various functions (e.g. option-t/PlainResult).

If you're project cannot import by their path, please read this guide to know more details.

Deprecation

All deprecated items including "not recommended" are marked as @deprecated in JSDoc. Please read this guide to know more details.

See also

These documents would provide more information about Option<T> and Result<T, E>. These are written for Rust, but the essence is just same.

License

MIT License

Contribution

  • Use npm v9 or later to install dev-dependency toolchains.

Related works: Comparison with other similar packages

fp-ts is a package that provides various tools to write a functional programming style code including Either and Option type.

Our design’ origin is Rust language, so we also contains an essence of functional programming style which Rust language contains. In this point, features that we provide would be similar to fp-ts’ one.

However, we do not aim to provide a feature to write a functional programming language code unlike fp-ts. Our design goal is that we provide more specialized tools to handle an absence of values.

We think Effect-TS (v3.1.0) is also placed in here. Side-effect handling abstraction, concurrency controls, or platform integration are not a goal of this package. We intend to provide only value types that are evaluated immediately unlike them.

neverthrow is a package that provides Result type implementation. At this point, we think that we and they share the same spirits.

However, we think there are some different design decisions between neverthrow and us.

option-t does not provide a method chain style but have a perfect "tree-shakability"

We do not provide class based implementation and method chaining style. Historically, we had provided a method-chain style APIs and data types as tier 1.

But we gave up method chain style as primary style and switched our primary APIs to current simple functions combination style for various reasons.

First, there was a problem with dead code elimination. Dead code elimination (as known as DCE or “tree shaking” in JavaScript toolchain context) is important optimization. It reduces a final bundled code size after linking codes by a module bundler (linker).

However, it’s hard to remove unused object property methods in JavaScript. To remove them safely, an optimizer should know whether an object property is used or not over a whole of programs. But this kind of optimization requires perfect call graph information too. This kind of optimization is easy relatively with a static language like C++ or Rust but JavaScript is a dynamic language essentially. JavaScript has a multiple way to prevent a this kind of optimization like a reflection (e.g. Object.keys(obj)). So it’s hard.

Under this condition, we cannot add a feature as property methods without increase the final code size. We would like to add a popular feature as a part of this package to reuse it or would like to fill a gap with Rust's original feature set. But a user project does not use all features at all times. They use a partial of this package generally. Even if an user project does not use them, features provided as an object property method are not removed, so it increases a final application size. This might be a big problem for client-side applications, especially to implement SDK libraries. Thus we would like to avoid it sincerely.

Exceptionally, as our memory, Google Closure Compiler’s advanced optimization mode can do such aggressive dead code elimination about an unused object property as a part of static optimization. But it’s not a popular toolchain choice in the 2010s later. We could not expect that a user project accept it as a popular choice rather than UglyfyJS, terser, or other code minifier lacking an analysis whole of programs statically.

Second, there was a problem with TypeScript’s type inference. In 2016~2018, our method chain style implementation sometimes fall into that a type parameter for generics fallback to any or unknown in the middle of a long (relatively complex) method chain in our user project. This causes to break a type integrity whole of a project and causes a bad developer experience.

Third, there was a problem making it hard to keep a consistent behavior with mixing multiple versions in a project dependency. A class based object implementation often supports instanceof check naturally as a part of APIs implicitly. However, if there are multiple versions of same name package in a project dependencies by aggregating them with semantic versioning, instanceof behavior might be inconsistent as contrary to expectations of a developer.

For example, the following code will result as false. This is just unsound.

// This is some_package@v2 actually.
import { SomeClass } from 'some_package';
// This package uses some_package@v1 as dependency.
import { getBar } from 'other_package';

// This value is some_package@v1's instance
// that have the same type shape with some_package@v2's same named class instance.
const bar = getBar();
// Developers think this should be `true`, but the actual is `false`.
console.log(bar instanceof SomeClass); // false

You may think TypeScript’s static type system can fix this problem, but it cannot do. TypeScript’s type system uses structural subtyping. This example is valid if the bar and SomeClass (instance) have the same type shape. As a result, it’s bad behavior. To fix above problems, we gave up method chain style and made it deprecated.

Fourth, a new programming style for web application in JavaScript is emerging that mixes a code execution context either with a client or a server (e.g. Qwik). With their style, each of objects are required to be serializable to allow to transfer a data from the server to the client across boundaries. We cannot use method chains in such a case.

Finally, we shifted to provide a set of minimum types and various standalone "operator" functions. This design allows us to "tree-shaking" perfectly to remove unused functions.

Of course, we know this design style is a boring programming style. If pipeline operator proposal advance to the part of ECMA262 spec, this boring style problem might be relaxed.

Furthermore, we think that it happens many times reading the code but writing one is fewer than it. We believe that this style is tiring but not a problem in the long term.

Package Sidebar

Install

npm i option-t

Weekly Downloads

64,953

Version

49.0.1

License

MIT

Unpacked Size

761 kB

Total Files

739

Last publish

Collaborators

  • tetsuharu