hexo/node_modules/assert-never
jkjoy 5d2d87c740 20230925 2023-09-25 15:58:56 +08:00
..
README.md 20230925 2023-09-25 15:58:56 +08:00
index.d.ts 20230925 2023-09-25 15:58:56 +08:00
index.js 20230925 2023-09-25 15:58:56 +08:00
index.ts 20230925 2023-09-25 15:58:56 +08:00
package.json 20230925 2023-09-25 15:58:56 +08: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);
}