https://github.com/teves-castro/ts-do

Do like notation for typescript using fp-ts
https://github.com/teves-castro/ts-do

do-notation fp-ts functional-programming

Last synced: about 1 month ago
JSON representation

Do like notation for typescript using fp-ts

• Host: GitHub
• URL: https://github.com/teves-castro/ts-do
• Owner: teves-castro
• License: mit
• Created: 2018-01-20T20:54:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:42:25.000Z (over 1 year ago)
• Last Synced: 2024-07-20T01:13:21.048Z (about 2 months ago)
• Topics: do-notation, fp-ts, functional-programming
• Language: TypeScript
• Size: 1.16 MB
• Stars: 56
• Watchers: 6
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Description

This library works as an extension for [fp-ts](https://github.com/gcanti/fp-ts) allowing the usage of a haskell like do notation. One can use exec, bind, sequence and into to chain computations on any of the supplied monads.

Each bind or sequence in the computation chain contributes to a threaded context that is available to each subsequent step. The exec function can also be used to perform computations that add nothing to the context for their side-effects.

It is possible to use this with any monads as long as its kind is defined in fp-ts.

# Installation

To install the stable version:

```bash

yarn add ts-do

```

# Using the extension

Start by importing the extension:

```typescript

import { some, map, option } from "fp-ts/lib/Option"

import { pipe } from "fp-ts/lib/pipeable"

import { array } from "fp-ts/lib/Array"

import { range, sum } from "ramda"

import * as Do from "ts-do"

const bind = Do.bind(option)

const into = Do.into(option)

const exec = Do.exec(option)

const sequence = Do.sequence(array, option)

const result = pipe(

  some(3),

  into("x"), // Chains the computation. Creates a context with { x: 3 }

  exec(() => some(undefined)), // Chains the computation. Adds nothing to the context

  sequence("ys", ({ x }) => range(0, x).map(() => some(1))), // Sequences computations. Adds { ys: [1, 1, 1] } to the context

  map(({ x, ys }) => x - sum(ys)),

)

// result === some(0)

```

Check the test folder for a few more examples.

# Building

Clone the repo

```bash

git clone [email protected]:teves-castro/ts-do.git

```

Install dependencies

```bash

yarn

```

Test

```bash

yarn run test

```

Compile

```bash

yarn run build

```

# Disclaimer

These kind of operations (do notation) should be done with compiler support, like the special case of async/await for promises, that is included in most major languages these days.

Although these languages are adopting more and more functional programming constructs, sadly more advanced concepts are left out due to not having critical mass to demand it's implementation.

So, this is an experiment on what can be accomplished without that compiler support. Meaning that if/when this is supported natively by the language itself, certainly with different syntax, this will become obsolete.

Also I make no commitment to evolve the library beyond my own needs, so bear these warnings in mind when using the library.

And of course I appreciate any comments and suggestions on how to improve or on how I completely blundered something.