1.0.1 • Published 5 years ago
zircaloy-server v1.0.1
Zircaloy HTTP Server
This package is an ultra light weight server wrapper for node. It belongs to the Zircaloy light weight framework
Installation
Use the package manager npm to install.
npm i zircaloy-serverFeatures
Current
- Easy to use
- Zero dependencies
- JSON Body parser
- URL Encoded Body Parser
Future:
- HTTPS support
- Octet Stream parsing
- Whitelisting IPs
- Automated responses for invalid and forbidden requests
Usage
Instanciate
const ZServer = require('zircaloy-server');
const requestHandler = async (req, res) => {
// Handle
};
const Server = ZServer.createServer(requestHandler);
Server.listen(4005, () => {
console.log(`Application listening on port 4005..`);
});
Server.on('request', async (req, res) => {
console.log(`[${req.method}] New request received '${req.url}'`);
});Handling Request Example
const requestHandler = async (req, res) => {
const { baseUrl, method, headers, query, body } = req;
// Process your request
ZServer.setHeaders(res, {
'x-header-example-string': '*',
'x-header-example-array': ['GET', 'POST', 'PUT', 'DELETE'],
});
ZServer.setStatusCode(res, 200, { 'Content-Type': 'application/json' }); // Send more headers
ZServersendResponse(res, JSON.stringify({ message: 'Hello World!!' }));
};APIs
- createServer (requestHanlder)
Creates a raw node http Server.
| Param | Type | Description |
|---|---|---|
| requestHandler | function | The callback that will be called when a request arrive |
- setHeaders (response, headers)
Sets the response headers.
| Param | Type | Description |
|---|---|---|
| response | object | Node's response object |
| headers | object | Headers to be sent to the client |
- setStatusCode (response, code , headers)
Sets the response status code.
| Param | Type | Description |
|---|---|---|
| response | object | Node's response object |
| code | number | HTTP code of the response |
| headers | object | Optional Headers to be sent to the client |
- sendResponse (response, body)
Sets the response status code.
| Param | Type | Description |
|---|---|---|
| response | object | Node's response object |
| body | string | The body to be sent to the client |
- sendStream (response, stream, callbackSuccess, ****)
Sets the response status code.
| Param | Type | Description |
|---|---|---|
| response | object | Node's response object |
| stream | readable stream | Stream to be forwaded to the client |
| callbackSuccess | function | Function to be called on success |
| callbackError | function | Function to be called on error |
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
MIT License
Copyright (c) 2019 Gonzalo Spina
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.