/marble

Marble.js - functional reactive Node.js framework for building server-side applications, based on TypeScript and RxJS.

Primary LanguageTypeScriptMIT LicenseMIT

Marble.js logo

GitHub Actions npm version Codecov coverage Maintained with lerna Gitter

Functional reactive Node.js framework for building server-side applications, based on TypeScript and RxJS.

Philosophy

The core concept of Marble.js assumes that almost everything is a stream. The main building block of the whole framework is an Effect, which is just a function that returns a stream of events.

The purely functional languages like Haskell expresses side effects such as IO and other stateful computations using monadic actions. With big popularity of RxJS Observable monad you can create a referential transparent program specification made up of functions that may produce side effects like network, logging, database access, etc. Using its monadic nature we can map I/O operations over effects and flat them to bring in other sequences of operations. Marble.js is a functional reactive framework, thats why RxJS is a first class citizen here. It’s a much more powerful and feature-rich monad than IO that implements the basic abstract interface as well as a ton of additional functionalities for manipulating sequences of events over time.

When looking at Marble.js you can ask: "Why do we need RxJS for HTTP?". Despite of the single event nature of basic HTTP, there are no contraindications against using it for single events. In Marble, RxJS is used as a hammer for expressing asynchronous flow with monadic manner, even if you have to deal with only one event passing over time. Marble.js doesn't operate only over basic protocol, but can be used also for both WebSocket and event sourcing purposes, where the multi-event nature fits best. Don't be scared of the complexity and abstractions presented in RxJS API — the Marble.js framework in general is incredibly simple.

For those who are curious about the framework name - it comes from a popular way of visually expressing the time-based behavior of event streams, aka marble diagrams. This kind of domain specific language is a popular way for testing asynchronous streams especially in RxJS environments.

Ecosystem

Name Description
@marblejs/core Framework core module
@marblejs/websockets WebSockets module
@marblejs/middleware-logger Logger middleware
@marblejs/middleware-body Body parser middleware
@marblejs/middleware-io I/O validation middleware
@marblejs/middleware-jwt JWT autgorization middleware
@marblejs/middleware-joi JOI-based validation middleware
@marblejs/middleware-cors CORS middleware
@marblejs/middleware-multipart Multipart middleware

Documentation

For the latest updates, documentation, change log, and release information visit docs.marblejs.com and follow @marble_js on Twitter.

Examples

To view the example project, visit the example repository.

Authors

Józef Flakus

contact: hello@jflakus.com

twitter: @jozflakus

Contributors

Sebastian Musial

Patryk Domałeczny

Lúcio Rubens

Krzysztof Miemiec

Edouard Bozon

License

marble.js is MIT licensed