Documents / @faasjs/server / Server

Class: Server

FaasJS Server.

Param

The root path of the server.

Param

The options of the server.

Example

import { Server } from '@faasjs/server'

const server = new Server(process.cwd(), {
  port: 8080,
})

server.listen()

Constructors

Constructor

new Server(root, opts): Server

Parameters

root

string

opts

ServerOptions = {}

Returns

Server

Methods

close()

close(): Promise<void>

Close server.

Returns

Promise<void>

handle()

handle(req, res, options): Promise<void>

Parameters

req

IncomingMessage

res

ServerResponse<IncomingMessage>

options

ServerHandlerOptions = {}

Returns

Promise<void>

listen()

listen(): Server

Start server.

Returns

Server

middleware()

middleware(req, res, next): Promise<void>

Middleware function to handle incoming HTTP requests.

Parameters

req

IncomingMessage

The incoming HTTP request object.

res

ServerResponse<IncomingMessage>

The server response object.

next

() => void

A callback function to pass control to the next middleware.

Returns

Promise<void>

A promise that resolves when the middleware processing is complete.

Properties

closed

protected closed: boolean = false

logger

readonly logger: Logger

options

readonly options: ServerOptions

root

readonly root: string