Skip to content

Playing actual music over fp-ts notes

License

Notifications You must be signed in to change notification settings

facile-it/fortepiano

Repository files navigation

fortepiano [ˌfɔrteˈpjaːno]

Playing actual music over fp-ts notes

GitHub Workflow Status Codecov GitHub npm

Description

fortepiano provides a set of common abstractions for functional application development (e.g., Http, Storage...), while extending fp-ts with useful modules à la fp-ts-contrib.

Getting Started

fortepiano stands on the shoulders of the giant fp-ts. As such, a good understanding of its concepts is suggested.

Installation

The package is available via npm, and must be installed along with its peer dependencies:

npm install fortepiano fp-ts io-ts io-ts-types

Additional packages are required, shall you want to use specific abstractions:

Usage

Import modules (e.g., values) from package index and types from specific modules. "Function" module and abstraction implementations are an exception:

import { $type } from 'fortepiano'
import { Struct } from 'fortepiano/struct'
import { curry } from 'fortepiano/function'
import { $axios } from 'fortepiano/http/Axios'

Contributing

See the CONTRIBUTING.md file for details.

Authors

License

This project is licensed under the MIT License. See the LICENSE.md file for details.