Marble.js

Marble.js is composed of several specialized modules that can be used to build different parts of a server-side application:

• @marblejs/core: The framework's core module.
• @marblejs/http: Provides HTTP capabilities.
• @marblejs/websockets: Provides WebSocket support.
• @marblejs/messaging: Provides messaging capabilities.
• @marblejs/testing: Provides testing utilities.
• @marblejs/middleware-logger: Logger middleware.
• @marblejs/middleware-body: Body parser middleware.
• @marblejs/middleware-io: I/O validation middleware.
• @marblejs/middleware-cors: CORS middleware.
• @marblejs/middleware-multipart: Multipart middleware.

Install the @marblejs/websockets module using npm. This module requires @marblejs/core, rxjs, and fp-ts to be present in your project dependencies.

$ npm i @marblejs/websockets

To enable Cross-Origin Resource Sharing (CORS) in your Marble.js application, import cors$ from @marblejs/middleware-cors and include it in your middlewares array when initializing your httpListener. This allows you to control which origins, methods, and headers are permitted for incoming requests.

import { cors$ } from '@marblejs/middleware-cors';

const middlewares = [
  logger$,
  cors$(
    {
      origin: '*', // Allow all origins
      methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
      optionsSuccessStatus: 204,
      allowHeaders: '*', // Allow all headers
      maxAge: 3600,
    }
  )
];

const effects = [
  endpoint1$,
  endpoint2$,
  ...
];

const app = httpListener({ middlewares, effects });

Install the @marblejs/middleware-body package via npm. This middleware requires @marblejs/core and @marblejs/http to be installed in your project to function correctly.

$ npm i @marblejs/middleware-body

Install the logger middleware using npm. Note that this package requires @marblejs/core and @marblejs/http to be installed in your project as dependencies.

$ npm i @marblejs/middleware-logger

Install the IO validation middleware using npm. Note that this package requires @marblejs/core to be installed as a dependency.

$ npm i @marblejs/middleware-io

To use the HTTP module in your Marble.js project, install it via npm. Note that this package has peer dependencies on @marblejs/core, rxjs, and fp-ts which must also be present in your project.

$ npm i @marblejs/http

Install the multipart middleware using npm. This package requires @marblejs/core and @marblejs/http to be installed in your project.

$ npm i @marblejs/middleware-multipart

Install the @marblejs/messaging module using npm. This module requires @marblejs/core, rxjs, and fp-ts to be present in your project dependencies.

$ npm i @marblejs/messaging

Marble.js uses a Context object to implement dependency injection. A Context is essentially a map where keys are ContextTokens and values are ContextDependencys. Dependencies can be provided in two ways:

1. Eager Dependencies (ContextEagerReader): Evaluated immediately when the context is resolved.
2. Lazy Dependencies (ContextLazyReader): Evaluated only when the dependency is looked up for the first time.

To build a context, you can use createContext() to start with an empty context, and then use register, registerAll, bindLazilyTo, or bindEagerlyTo to populate it.