Coder Social home page Coder Social logo

bs-rebel's Introduction

bs-rebel

Rebel is a toolkit for collection APIs that work with both bsb-native and bsb.

When you're aiming to write libraries with BuckleScript you're often made to choose between using convenient APIs that only work when compiling to JS, like Js.Array or to include more bs-platform/lib code, like Array or Belt.

Think of Rebel as a standard library wrapper. It aims to use JS built-ins as often as possible, but falls back to using the BuckleScript standard library on native.

(Its name comes from "Re" as in "Reason" and "bel" as in "belt")

Getting Started

Install the library from npm:

yarn add bs-rebel
# or for npm
npm install --save bs-rebel

And add bs-rebel to your bsconfig.json

{
  "name": "<your name>",
  "version": "0.1.0",
  "sources": ["src"],
  "bsc-flags": ["-bs-super-errors"],
  "bs-dependencies": [
+    "bs-rebel"
  ]
}

All of Rebel's module are namespaced as Rebel, so for instance to access the MutableQueue module use: Rebel.MutableQueue

Supported APIs

MutableQueue

See Belt.MutableQueue for this module's signature.

In JS, this module uses externals to mirror as many functions from the Belt module as possible. The only functions that don't completely compile away (but are rather small) are reduce, reduceU, and transfer.

It also adds an addMany function that does compile away, but isn't part of the standard Belt.MutableQueue module.

MutableStack

See Belt.MutableStack for this module's signature.

In JS, this module uses externals to mirror as many functions from the Belt module as possible. The only functions that don't completely compile away (but are rather small) are isEmpty and top.

It does not implement dynamicPopIterU and dynamicPopIter.

Array

See Rebel_types.re for this module's signature. Unfortunately there are no auto-generated docs yet.

This module slightly diverges from Array, Js.Array, and Belt.Array. It tries to match the implementation of the JS Array methods as closely as possible. However, there are some in-place modification methods that are not implemented in Belt.Array and are thus not included in Rebel.Array.

Other methods like filter and removeCount are present though.

The JS externals that don't compile away completely are:

  • set (as opposed to setUnsafe which compiles away)
  • reverse (as opposed to reverseInPlace which compiles away)
  • remove (as opposed to removeInPlace which compiles away)
  • removeCount (as opposed to removeCountInPlace which compiles away)
  • shuffle
  • shuffleInPlace
  • make
  • set
  • includes

Some JS-only methods are for completeness' sake still included in Rebel.Array.Js, but they won't be available during native compilation!

bs-rebel's People

Contributors

kitten avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.