https://github.com/craft-ai/most-utils

most js addons cf. https://github.com/cujojs/most
https://github.com/craft-ai/most-utils

mostjs reactive-programming stream

Last synced: about 1 month ago
JSON representation

most js addons cf. https://github.com/cujojs/most

• Host: GitHub
• URL: https://github.com/craft-ai/most-utils
• Owner: craft-ai
• License: bsd-3-clause
• Created: 2017-08-07T07:48:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-14T17:27:10.000Z (over 6 years ago)
• Last Synced: 2024-10-13T21:29:34.455Z (2 months ago)
• Topics: mostjs, reactive-programming, stream
• Language: JavaScript
• Homepage:
• Size: 129 KB
• Stars: 5
• Watchers: 11
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `most` utils #

[![Build](https://img.shields.io/travis/craft-ai/most-utils/master.svg?style=flat-square)](https://travis-ci.org/craft-ai/most-utils)

[![Coverage Status](https://img.shields.io/coveralls/github/craft-ai/most-utils/badge.svg?style=flat-square)](https://coveralls.io/github/craft-ai/most-utils)

[![License](https://img.shields.io/badge/license-BSD--3--Clause-42358A.svg?style=flat-square)](https://github.com/craft-ai/most-utils/blob/master/LICENSE)

A collection of utilities for [most](https://github.com/cujojs/most).

## Packages ##

### [`most-buffer`](./packages/most-buffer) [![Version](https://img.shields.io/npm/v/most-buffer.svg?style=flat-square)](https://npmjs.org/package/most-buffer) ###

Gather most js streams events into buffers.

### [`most-limiter`](./packages/most-limiter) [![Version](https://img.shields.io/npm/v/most-limiter.svg?style=flat-square)](https://npmjs.org/package/most-limiter) ###

Lossless rate limiter for most js.

### [`most-nth`](./packages/most-nth) [![Version](https://img.shields.io/npm/v/most-nth.svg?style=flat-square)](https://npmjs.org/package/most-nth) ###

Retrieve the nth event in a stream as a Promise.

### [`most-range`](./packages/most-range) [![Version](https://img.shields.io/npm/v/most-range.svg?style=flat-square)](https://npmjs.org/package/most-range) ###

Create ranges of integers as most js streams.

## Developers ##

### Local development & testing ###

These packages requires [Node v6.9](https://nodejs.org/en/download/) or later and [yarn](https://yarnpkg.com/en/docs/install).

> The following commands can be run in the root directory or in any of the package's

- Install dependencies:

  ```console

  $ yarn install

  ```

- Lint the code:

  ```console

  $ yarn run lint

  ```

- Run the tests:

  ```console

  $ yarn run test

  ```

### Releasing a new version (needs administrator rights) ###

1. Make sure the build of the master branch is [passing](https://travis-ci.org/craft-ai/most-utils).

2. Checkout the master branch locally.

  ```console

  $ git fetch

  $ git checkout master

  $ git reset --hard origin/master

  ```

4. Increment the version of all packages and move _Unreleased_ section

   of `CHANGELOG.md` to a newly created section for this version.

  ```console

  $ ./scripts/update_version.sh patch

  ```

  `./scripts/update_version.sh minor` and `./scripts/update_version.sh major` are

  also available - see [semver](https://semver.org/) for a guideline on when to

  use which.

  > This will create a git commit and a git tag.

5. Push everything.

  ```console

  $ git push origin master --tags

  ```

  > This will trigger the publishing of this new version of the packages by [travis](https://travis-ci.org/craft-ai/most-utils).