open-index/open-npm huggingface dataset:
npm package: @mauna-ai/bsdoc-linux
Description: > Documentation Generation for BuckleScript projects
Latest version: 6.0.5

# bsdoc

> Documentation Generation for BuckleScript projects

[![npm](https://img.shields.io/npm/v/bsdoc.svg)](https://npmjs.org/package/bsdoc)
[![Build Status](https://dev.azure.com/yawaramin/bsdoc/_apis/build/status/reasonml-community.bsdoc?branchName=master)](https://dev.azure.com/yawaramin/bsdoc/_build/latest?definitionId=5&branchName=master)

Read more in the docs: [BsDoc](https://reasonml-community.github.io/bsdoc)

## Usage

Install in your project using `npm` or `yarn`:

```sh
$ yarn add bsdoc
```

And whenever you want to generate your docs you can run:

```sh
# Build your docs!
MyProject $ yarn run bsdoc build MyProject
yarn run v1.12.3
$ ./node_modules/.bin/bsdoc build MyProject
info: Compiling documentation for package "MyProject"...
info: Generating .html files...
info: Done ✅
✨  Done in 0.58s.
```

Additionally, to install the support files (default CSS and Javascript), you
can run:

```sh
# Create the support files
MyProject $ yarn run bsdoc support-files
yarn run v1.12.3
$ ./node_modules/.bin/bsdoc support-files
info: Copying support files (CSS, JS) into ./docs
info: Done ✅
✨  Done in 0.53s.
```

## Contributing

`bsdoc` is developed as a Native Reason project, and is only possible thanks to
`esy`, `dune`, and, naturally, `odoc`.

If you haven't installed Esy yet, follow the instructions in their web site:
https://esy.sh

After you have done that, you need only run `esy build` to get the project
bootstrapped.

## Installing on Linux/Windows

Unfortunately I haven't gotten around publishing `bsdoc` for Linux/Windows, but if you have `npm` installed you can run:

```sh
$ esy build
$ esy npm-release
```

And that'll get you an npm package that you can then install locally (or globally) in any of your projects. Be mindful that it'll only work for `bs-platform@6`+ projects!
npm package: @mauna/reason-web-streams
Description: Web Streams Polyfill bindings for Reasonml
Author: Philip Balbas
Latest version: 0.1.10-development

# @mauna/reason-web-streams

![npm](https://img.shields.io/npm/v/@mauna/reason-web-streams)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


ReasonWebStreams is the Reason bindings for [web-streams-polyfill](https://github.com/MattiasBuelens/web-streams-polyfill).

## Install

```
npm i @mauna/reason-web-streams
```

Add it to `bsconfig.json`

```diff
  "bs-dependencies": [
+   "@mauna/reason-web-streams",
  ]
```

You can now use the **MaunaReasonWebStreams** module.

## Usage

```re
open MaunaReasonWebStreams

let underlyingSource: ReadableStream.underlyingSource('a) = {
  start: None,
  pull: None,
  cancel: None,
  type_: None,
};

let strategy: ReadableStream.queuingStrategy('a) = {
  highWaterMark: None,
  size: None,
};

let readable =
  ReadableStream.make(~underlyingSource, ~strategy=Some(strategy), ());

```