A minimal base library for Reason
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
examples
src
.gitignore
.travis.yml
LICENSE
README.md
bsconfig.json
package-lock.json
package.json

README.md

re:base

A minimal base library intended for the BuckleScript/Reason ecosystem. Uses Reasonable conventions and is easily consumed via npm.

npm Travis Coveralls Issues Last Commit

Status

Mostly undocumented and untested. Prone to change without warning. Use at your own risk.

Project Goals

  • Cross-platform
  • Compile to efficient JavaScript code
  • Compile to readable JavaScript code

Design Principles

  • JS first
  • No platform-specific APIs exposed
  • Prefer piped form, e.g. "a" |> String.concat("b") == "ab"
  • The subject of functions in type-wrapping modules should always be t
  • Enforce common patterns using module signatures

Installation

npm install --save @glennsl/rebase

Then add @glennsl/rebase to bs-dependencies in your bsconfig.json:

{
  ...
  "bs-dependencies": ["@glennsl/rebase"]
}

Documentation

For the moment, please see Rebase.rei. There's not many doc comments yet, but most functions should be pretty self-explanatory.