CoolWeb

Fast, lightweight, Express-inspired web framework for Node.js.

Installation

npm install coolweb

Quick Start

import coolweb from "coolweb";

const app = coolweb();

app.get("/", (stream) => {
	stream.send("Hello World!");
});

app.listen(3000, () => {
	console.log("Server listening on port 3000");
});

API

Handlers

Handler

Standard middleware and route handler.

const handler: Handler = (stream, next) => {
	...
}

• stream - Current request/response stream
• next - Invokes the next handler in the chain.

Note

Calling next() continues execution with the next handler.

Calling next(error) skips normal handlers and continues with the next matching error handler.

ErrorHandler

Executed when an error is passed to next().

const errorHandler: ErrorHandler = (error, stream, next) => {
	...
};

• error - The error that was passed to next().
• stream - Current request/response stream
• next - Invokes the next handler in the chain.

Server

coolweb()

Creates a new application instance.

Returns App

app.listen(listener[, cb])

Starts the server.

• listener - Port, server instance, or listener target.
• cb (optional) - Called when the server begins listening.

Returns App

app.listen(listener[, options])

Starts the server with additional configuration.

• listener - Port, server instance, or listener target.

• options (optional) - Configuration object.

  • cb (optional) - Called when the server begins listening.
  • cert (optional) - TLS certificate for HTTPS.
  • key (optional) - TLS private key for HTTPS.

Returns App

app.get(path, ...handlers)

app.post(path, ...handlers)

app.put(path, ...handlers)

app.patch(path, ...handlers)

app.delete(path, ...handlers)

app.head(path, ...handlers)

Registers a route for the corresponding HTTP method.

• path - Route path.
• handlers - One or more route handlers. Error handlers are ignored.

Returns App

app.use(...handlers)

Registers standart middleware, error middleware, or child applications.

• handlers - Middleware functions, error handlers, or applications.

Returns App

app.use(path, ...handlers)

Registers path-specific standart middleware, error middleware, or child applications.

Parameters

• path - Mount path.
• handlers - Middleware functions, error handlers, or applications.

Returns App

app.param(name, ...paramHandlers)

Registers parameter middleware.

Parameter handlers are executed whenever the specified route parameter is matched.

Parameters

• name - Parameter name or an array of parameter names.
• paramHandlers - One or more parameter handlers.

Returns App

ParamHandler

Called when a matching route parameter is encountered.

const paramHandler: ParamHandler = (stream, next, value, key) => {
	...
};

• stream - The current request/response stream.
• next - Invokes the next handler in the chain.
• value - The matched parameter value. Could be undefined
• key - The matched parameter key.

Stream