https://github.com/pokle/ioperator

An exploration of the Haskell IO patterns, in pure Javascript
https://github.com/pokle/ioperator

Last synced: 10 days ago
JSON representation

An exploration of the Haskell IO patterns, in pure Javascript

• Host: GitHub
• URL: https://github.com/pokle/ioperator
• Owner: pokle
• Created: 2017-10-12T14:34:51.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-06T12:33:51.000Z (about 7 years ago)
• Last Synced: 2024-10-27T05:05:09.713Z (22 days ago)
• Language: JavaScript
• Homepage:
• Size: 141 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ioperator

Helps separate your logic from your Input Output operations.

Examples of IO operations are HTTP requests, file system requests, database requests, and generally any functions that have side effects. Functions with side effects are hard to test because they are usually not repeatable.

Keeping your logic pure (free of side-effects) makes it much easier to test, and more generally much easier ot reason about.

ioperater is heavily influenced by Haskell's treatment of IO - Your pure functions describe what needs to be done by returning an IO value. They never perform IO by themselves.

[![Build Status](https://travis-ci.org/pokle/ioperator.svg?branch=master)](https://travis-ci.org/pokle/ioperator)

Install: `npm install --save ioperator`

## Why?

Functions that perform input & output operations are usually quite hard to test. (As opposed to pure functions)

- You might use mocking techniques - painful.

- You might use dependency injection (to inject mocks and genuine implementations)

Dependency injection can be problematic because you have to pass your dependencies all the way through your function call hierarchy. With ioperator, your functions compose easier because you're never passing down dependencies.

## Influences

- Haskell IO Monad

- Purescript Effects, Aff, and IO

- funfix's IO type (https://github.com/funfix/funfix)

- From dependency injection to dependency rejection (http://blog.ploeh.dk/2017/01/27/from-dependency-injection-to-dependency-rejection/)

- https://github.com/thunks/thunks

## Example

Head over to runkit to play with an example that lower cases files on the filesystem: https://runkit.com/pokle/ioperator-lowercase-file