Alwatr
Alwatr NanoServer - @alwatr/nano-server
Elegant powerful nodejs server for nanoservice use cases, written in tiny TypeScript module.
Example usage
import {type AlwatrConnection, AlwatrNanoServer} from 'https://esm.run/@alwatr/nano-server';
const nanoServer = new AlwatrNanoServer();
nanoServer.route('GET', '/', async (connection: AlwatrConnection) => {
connection.reply({
ok: true,
data: {
app: 'Alwatr Nanoservice Starter Kit',
message: 'Hello ;)',
},
});
});API
AlwatrNanoServer(config?: Partial<Config>)
Create a server for nanoservice use cases.
Example:
import {AlwatrNanoServer} from 'https://esm.run/@alwatr/nano-server';
const nanoServer = new AlwatrNanoServer();nanoserver.close()
Stops the HTTP server from accepting new connections.
route(method: Methods, route: 'all' |/${string},middleware: (connection: AlwatrConnection) => void)
Refers to how an application’s endpoints (URIs) respond to client requests.
Example:
nanoServer.route('GET', '/', middleware);AlwatrConnection(incomingMessage: IncomingMessage, serverResponse: ServerResponse)
????
async function middleware(connection: AlwatrConnection) => {
connection.reply({
ok: true,
data: {
app: 'Alwatr Nanoservice Starter Kit',
message: 'Hello ;)',
},
});
});connection.url: URL
Request URL.
`connection.method: "ALL" | "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "TRACE" | "OPTIONS" | "PATCH"
`
Request method.
connection.getBody(): Promise<string | null>
Get request body for POST, PUT and POST methods..
Example:
const body = await connection.getBody();connection.getToken(): string | null
Get the token placed in the request header.
connection.reply(content: ReplyContent)
Example:
nanoServer.route('GET', '/', async (connection) => {
connection.reply({
ok: true,
data: {
app: 'Alwatr Nanoservice Starter Kit',
message: 'Hello ;)',
},
});
});connection.requireJsonBody()
Parse request body.
Example:
const bodyData = await connection.requireJsonBody();
if (bodyData == null) return;requireToken(validator: ((token: string) => boolean) | Array<string> | string): string | null
Parse and validate request token. Returns request token.
Example:
const token = connection.requireToken((token) => token.length > 12);
if (token == null) return;requireQueryParams<T>(params: Record<string, ParamType>): T | null
Parse and validate query params. Returns query params object.
Example:
const params = connection.requireQueryParams<{id: string}>({id: 'string'});
if (params == null) return;
console.log(params.id);