{"id":13496259,"url":"https://github.com/rzeigler/waveguide","last_synced_at":"2025-03-28T18:31:46.658Z","repository":{"id":34242838,"uuid":"171579210","full_name":"rzeigler/waveguide","owner":"rzeigler","description":"An effect/IO datatype in typescript","archived":false,"fork":false,"pushed_at":"2022-12-03T01:12:32.000Z","size":1598,"stargazers_count":101,"open_issues_count":12,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-23T21:04:08.710Z","etag":null,"topics":["effects","functional-programming","javascript","typescript"],"latest_commit_sha":null,"homepage":"https://rzeigler.github.io/waveguide","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rzeigler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-20T01:32:47.000Z","updated_at":"2024-06-16T22:55:33.000Z","dependencies_parsed_at":"2023-01-15T05:35:13.288Z","dependency_job_id":null,"html_url":"https://github.com/rzeigler/waveguide","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzeigler%2Fwaveguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzeigler%2Fwaveguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzeigler%2Fwaveguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzeigler%2Fwaveguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rzeigler","download_url":"https://codeload.github.com/rzeigler/waveguide/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246080634,"owners_count":20720562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["effects","functional-programming","javascript","typescript"],"created_at":"2024-07-31T19:01:44.688Z","updated_at":"2025-03-28T18:31:46.082Z","avatar_url":"https://github.com/rzeigler.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003ch1 align=center\u003e\n\u003cimg src=\"logo/logotype.svg\" width=50%\u003e\n\u003c/h1\u003e\n\n# waveguide\n\n[![npm version](https://img.shields.io/npm/v/waveguide)](https://img.shields.io/npm/v/waveguide)\n[![npm version next](https://img.shields.io/npm/v/waveguide/next)](https://img.shields.io/npm/v/waveguide/next)\n[![CircleCI](https://circleci.com/gh/rzeigler/waveguide.svg?style=svg)](https://circleci.com/gh/rzeigler/waveguide) \n[![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\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nwaveguide has been superseded by [mikearnaldi/matechs-effect](https://github.com/mikearnaldi/matechs-effect). \nThis package is a based off a fork of waveguide, is used in production, and contains useful additional modules like a\nrequest client.\n\nWaveguide 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.\nFor a quick overview of waveguide in action see [the tutorial](https://github.com/rzeigler/waveguide/blob/master/examples/)\nA companion streaming library is being incubated in [waveguide-streams](https://github.com/rzeigler/waveguide-streams) \nand will eventually become part of the core\n\nIO is:\n- Lazy. Work is not done until explicitly asked for and interruption can be used to stop work that is no longer needed.\n- Efficient. Asynchronous boundaries only occur where necessary. The run loop will execute as much work as it can before suspending.\n- Interoperable. There are a functions to adapt Promises as well as the fp-ts effect types.\n- Resource safe. Exposes a number of primitives for working with resources and guaranteeing cleanup.\n- 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.\n\nFor more information see [the docs](https://rzeigler.github.io/waveguide) or [the tutorial](https://github.com/rzeigler/waveguide/blob/master/examples/).\n\nIf you have questions don't hesitate to ask them in the gitter.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frzeigler%2Fwaveguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frzeigler%2Fwaveguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frzeigler%2Fwaveguide/lists"}