https://github.com/rzeigler/waveguide

An effect/IO datatype in typescript
https://github.com/rzeigler/waveguide

effects functional-programming javascript typescript

Last synced: 3 months ago
JSON representation

An effect/IO datatype in typescript

• Host: GitHub
• URL: https://github.com/rzeigler/waveguide
• Owner: rzeigler
• License: apache-2.0
• Created: 2019-02-20T01:32:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T01:12:32.000Z (about 2 years ago)
• Last Synced: 2024-10-25T19:58:55.437Z (3 months ago)
• Topics: effects, functional-programming, javascript, typescript
• Language: TypeScript
• Homepage: https://rzeigler.github.io/waveguide
• Size: 1.52 MB
• Stars: 101
• Watchers: 11
• Forks: 6
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        






# waveguide

[![npm version](https://img.shields.io/npm/v/waveguide)](https://img.shields.io/npm/v/waveguide)

[![npm version next](https://img.shields.io/npm/v/waveguide/next)](https://img.shields.io/npm/v/waveguide/next)

[![CircleCI](https://circleci.com/gh/rzeigler/waveguide.svg?style=svg)](https://circleci.com/gh/rzeigler/waveguide) 

[![Join the chat at https://gitter.im/waveguide-core/community](https://badges.gitter.im/waveguide-core/community.svg)](https://gitter.im/waveguide-core/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

waveguide has been superseded by [mikearnaldi/matechs-effect](https://github.com/mikearnaldi/matechs-effect). 

This package is a based off a fork of waveguide, is used in production, and contains useful additional modules like a

request client.

Waveguide is a set of modules provided data types for describing effects in Typescript in the [fp-ts](https://github.com/gcanti/fp-ts) ecosystem inspired by scala projects such as [ZIO](https://github.com/scalaz/scalaz-zio) and [cats-effect](https://github.com/typelevel/cats-effect). Waveguide allows you to communicate with the real world in a referentially transparent manner.

For a quick overview of waveguide in action see [the tutorial](https://github.com/rzeigler/waveguide/blob/master/examples/)

A companion streaming library is being incubated in [waveguide-streams](https://github.com/rzeigler/waveguide-streams) 

and will eventually become part of the core

IO is:

- Lazy. Work is not done until explicitly asked for and interruption can be used to stop work that is no longer needed.

- Efficient. Asynchronous boundaries only occur where necessary. The run loop will execute as much work as it can before suspending.

- Interoperable. There are a functions to adapt Promises as well as the fp-ts effect types.

- Resource safe. Exposes a number of primitives for working with resources and guaranteeing cleanup.

- Concurrent. Exposes a logical fiber model with support for joins and interrupts. Write your code as a sequence of effects and communicate with other fibers rather than trying to juggle the state of all concurrent processes at once.

For more information see [the docs](https://rzeigler.github.io/waveguide) or [the tutorial](https://github.com/rzeigler/waveguide/blob/master/examples/).

If you have questions don't hesitate to ask them in the gitter.