typescript-pattern-matching

Pattern matching for TypeScript

Usage no npm install needed!

<script type="module">
  import typescriptPatternMatching from 'https://cdn.skypack.dev/typescript-pattern-matching';
</script>

README

Pattern Matching for TypeScript

Paattern matching allows programmers to compare data with defined structures to easily pick one of the available expressions. Many languages that are designed as ‘functional programming languages’ have built-in keywords for pattern matching. Well know examples are F# (match … with) or Haskell (case … of). One language that works very well with functional programming but lacks those features is TypeScript. This library adds support pattern matching to TypeScript.

Read the article about this library for more context.

Features

The features of this library include:

  • Value patterns
  • Record patterns
  • Wildcard patterns
  • Good type inference based on the patterns
  • Negated patterns (including negated type inference)
  • Additional predicates (like when)

Quick Examples

type Option<a> = { kind: 'none' } | { kind: 'some', value: a }

let val: Option<string> = { kind: 'some', value: 'hello' }

match(val)
  .with({ kind: 'some' }, o => o.value)
  .run()

let blogOverviewResponse: any = /* ... */

match<any, Blog[] | Error>(blogOverviewResponse)
  .with([{Id: Number, Title: String}], r => r.map(b => ({id: b.Id, title: b.Title})))
  .with({ errorMessage: String },      r => new Error(r.errorMessage))
  .otherwise(                         () => new Error('client parse error'))
  .run()

About

This library is written by Wim Jongeneel