Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhuntdev/blest-js
The NodeJS reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer), an improved communication protocol for web APIs which leverages JSON, supports request batching by default, and provides a modern alternative to REST.
https://github.com/jhuntdev/blest-js
api blest client connect express fastify hapi koa nodejs server
Last synced: 26 days ago
JSON representation
The NodeJS reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer), an improved communication protocol for web APIs which leverages JSON, supports request batching by default, and provides a modern alternative to REST.
- Host: GitHub
- URL: https://github.com/jhuntdev/blest-js
- Owner: jhuntdev
- License: mit
- Created: 2023-06-02T17:35:35.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-31T06:22:55.000Z (about 2 months ago)
- Last Synced: 2024-11-19T09:28:56.091Z (about 1 month ago)
- Topics: api, blest, client, connect, express, fastify, hapi, koa, nodejs, server
- Language: TypeScript
- Homepage:
- Size: 98.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BLEST.js
The NodeJS reference implementation of BLEST (Batch-able, Lightweight, Encrypted State Transfer), an improved communication protocol for web APIs which leverages JSON, supports request batching by default, and provides a modern alternative to REST. It includes examples for Connect, Express, Fastify, Hapi, and Koa.
To learn more about BLEST, please visit the website: https://blest.jhunt.dev
For a front-end implementation in React, please visit https://github.com/jhuntdev/blest-react
## Features
- Built on JSON - Reduce parsing time and overhead
- Request Batching - Save bandwidth and reduce load times
- Compact Payloads - Save even more bandwidth
- Single Endpoint - Reduce complexity and facilitate introspection
- Fully Encrypted - Improve data privacy
## Installation
Install BLEST.js from npm
With npm:
```bash
npm install --save blest-js
```
or using yarn:
```bash
yarn add blest-js
```
## Usage
### Router
This example uses Express, but you can find examples with other frameworks [here](examples).
```javascript
const express = require('express');
const { Router } = require('blest-js');
const app = express();
const port = 8080;
// Create some middleware (optional)
const authMiddleware = (params, context) => {
if (context.headers?.auth === 'myToken') {
return;
} else {
throw new Error('Unauthorized');
}
};
// Create a route controller
const greetController = (params, context) => {
return {
greeting: `Hi, ${params.name}!`
};
};
// Create a BLEST router
const router = new Router({ timeout: 1000 });
router.route('greet', authMiddleware, greetController);
// Parse the JSON body
app.use(express.json());
// Use the request handler
app.post('/', async (req, res, next) => {
const [result, error] = await router.handle(req.body);
if (error) {
return next(error);
} else {
res.json(result);
}
});
// Listen for requests
app.listen(port, () => {
console.log(`Server listening on port ${port}`);
});
```
### HttpClient
```javascript
const { HttpClient } = require('blest-js');
// Create a client
const client = new HttpClient('http://localhost:8080', {
maxBatchSize: 25,
bufferDelay: 10,
httpHeaders: {
// ...
}
});
// Send a request
client.request('greet', { name: 'Steve' }, { "auth": "myToken" })
.then((result) => {
// Do something with the result
})
.catch((error) => {
// Do something in case of error
});
```
## License
This project is licensed under the [MIT License](LICENSE).