JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14233
  • Score
    100M100P100Q160482F
  • License MIT

Utility types for functional TypeScript

Package Exports

  • @swan-io/boxed
  • @swan-io/boxed/dist/Boxed.js
  • @swan-io/boxed/dist/Boxed.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@swan-io/boxed) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@swan-io/boxed logo

@swan-io/boxed

mit licence npm version bundlephobia

Essential building-blocks for functional & safe TypeScript code

Boxed provides essential building-blocks (in the form of types and functions) so that you can write functional, safe TypeScript code.

Design principles

  • Provide utility types that make data-manipulation and storage easier
  • Immutable (all provided types are)
  • Give a good development experience (chaining API, reliable types)
  • Simple interoperability (you can convert back and forth to JS native types)
  • Compatibility with ts-pattern (using patterns we provide).

What's in the box?

  • Option<Value>
  • Result<Ok, Error>
  • Future<Value>
  • AsyncData<Value>
  • Lazy<Value>
  • Some utils like Deferred, Dict & Array

Installation

$ yarn add @swan-io/boxed
# --- or ---
$ npm install --save @swan-io/boxed