lunaisadev-website-old/node_modules/assert-never
Luna 4f63b4f9a0 first commit 2021-07-27 18:40:12 -07:00
..
README.md first commit 2021-07-27 18:40:12 -07:00
index.d.ts first commit 2021-07-27 18:40:12 -07:00
index.js first commit 2021-07-27 18:40:12 -07:00
index.ts first commit 2021-07-27 18:40:12 -07:00
package.json first commit 2021-07-27 18:40:12 -07:00

README.md

Assert Never npm version

Helper function for exhaustive checks of discriminated unions in TypeScript.

Installation

npm install --save assert-never

Usage

import {assertNever} from "assert-never";

type A = {type: 'a'};
type B = {type: 'b'};
type Union = A | B;

function doSomething(arg: Union) {
  if (arg.type === 'a') {
    return something;
  }

  if (arg.type === 'b') {
    return somethingElse;
  }

  // TS will error if there are other types in the union
  // Will throw an Error when called at runtime. Use `assertNever(arg, true)`
  // instead to fail silently.
  return assertNever(arg);
}