Documents / @faasjs/core / ServerOptions

Type Alias: ServerOptions

ServerOptions = object

Configuration options for Server.

Properties

beforeHandle?

optional beforeHandle?: Middleware

Middleware invoked before each request is dispatched to a FaasJS function.

Write to the response to short-circuit normal request handling.

Example

import { join } from 'node:path'
import { Server } from '@faasjs/core'

const server = new Server(join(process.cwd(), 'src'), {
  beforeHandle: async (req, res) => {
    console.log(`Processing ${req.method} request to ${req.url}`)

    if (req.method !== 'POST') res.writeHead(405, { Allow: 'POST' })
  },
})

onClose?

optional onClose?: (context) => Promise<void>

Async hook invoked after the server closes.

Use this hook for cleanup or shutdown logging.

Parameters

context

Lifecycle context passed to the close hook.

logger

Logger

Shared server logger instance.

Returns

Promise<void>

Promise returned by the close hook.

Example

import { join } from 'node:path'
import { Server } from '@faasjs/core'

const server = new Server(join(process.cwd(), 'src'), {
  onClose: async ({ logger }) => {
    logger.info('Server closed')
  },
})

onError?

optional onError?: (error, context) => Promise<void>

Async hook invoked when server-level errors occur.

This hook receives normalized Error instances.

Parameters

error

Error

Error raised during server operation.

context

Lifecycle context passed to the error hook.

logger

Logger

Shared server logger instance.

Returns

Promise<void>

Promise returned by the error hook.

Example

import { join } from 'node:path'
import { Server } from '@faasjs/core'

const server = new Server(join(process.cwd(), 'src'), {
  onError: async (error, { logger }) => {
    logger.error(error)
  },
})

onStart?

optional onStart?: (context) => Promise<void>

Async hook invoked after the server starts listening.

Errors thrown by this hook are reported through the server error logger.

Parameters

context

Lifecycle context passed to the start hook.

logger

Logger

Shared server logger instance.

Returns

Promise<void>

Promise returned by the start hook.

Example

import { join } from 'node:path'
import { Server } from '@faasjs/core'

const server = new Server(join(process.cwd(), 'src'), {
  onStart: async ({ logger }) => {
    logger.info('Server started')
  },
})

port?

optional port?: number

Port used by Server.listen.

Default

3000