True Myth

Appearance

Getting Started ​

True Myth has no additional dependencies and is ready to start using immediately after installation.

Requirements ​

  • Node 20+
  • TS 5.3+
  • tsconfig.json:
    • moduleResolution: use "Node16" or later
    • strict: true
  • package.json
    • type: "module" (or else use import() to import True Myth into a commonJS build)

For details on using a pure ES modules package in TypeScript, see the TypeScript handbook's guide.

Installation ​

Add True Myth to your dependencies:

sh
npm add true-myth
sh
yarn add true-myth
sh
pnpm add true-myth
sh
bun add true-myth

Basic Usage ​

True Myth is organized into modules within its public API, so you will generally not import from the root of the package, but from the dedicated module for each major type:

ts
import Maybe, * as maybe from 'true-myth/maybe';
import Result, * as result from 'true-myth/result';
import Task, * as task from 'true-myth/task';
import { exponential, jitter } from 'true-myth/task/delay';

If for some reason you need to import from the root, however, the default export and the full contents of each module are both available there. For example, you can import both the Maybe type and the contents of the true-myth/maybe module as a namespace like so:

ts
import { Maybe, maybe } from 'true-myth';

If you want to, you can even use a namespace import to reference all the types and namespaces from the root:

ts
import * as tm from 'true-myth';

function useMaybe(someMaybe: tm.Maybe<string>) {
  // ...
}