Hyperse Pipeline

Development

Set up, test and build the library locally.

Clone and install

git clone https://github.com/hyperse-io/pipeline.git
cd pipeline
yarn install

Common tasks

bash yarn build

Repository layout

pipeline/
├── src/
│   ├── helpers/      # functional utilities (curry, reduce, xwrap, …)
│   ├── middleware/   # Pipeline class + invocation
│   ├── reactive/     # pipe, exitPipe, pipeContext
│   └── types/        # type-level composition and monad detection
├── tests/
└── website/          # this documentation site

Submitting changes

  1. Create a branch from main.
  2. Make your change and run yarn test plus yarn typecheck.
  3. Add a changeset describing the release impact:
yarn changeset
  1. Open a pull request.

Conventional commits

Commit messages are validated with commitlint. Use the interactive prompt via yarn cz if you prefer a guided flow.

License

MIT — see the LICENSE file for details.

On this page