Skip to content
On this page

RemultServerOptions

  • RemultServerOptions

entities

Entities to use for the api

controllers

Controllers to use for the api

getUser

Will be called to get the current user based on the current request

Arguments:

  • request

initRequest

Will be called for each request and can be used for configuration

Arguments:

  • request
  • options
    • liveQueryStorage
    • remult

initApi

Will be called once the server is loaded and the data provider is ready

Arguments:

  • remult

dataProvider

Data Provider to use for the api.

seeConnecting to a Database.

ensureSchema

Will create tables and columns in supporting databases. default: true

description

when set to true, it'll create entities that do not exist, and add columns that are missing.

rootPath

The path to use for the api, default:/api

description

If you want to use a different api path adjust this field

defaultGetLimit

The default limit to use for find requests that did not specify a limit

logApiEndPoints

When set to true (default) it'll console log each api endpoint that is created

subscriptionServer

A subscription server to use for live query and message channels

liveQueryStorage

A storage to use to store live queries, relevant mostly for serverless scenarios or larger scales

requestSerializer

Used to store the relevent request info for re running a live query

queueStorage

Storage to use for backend methods that use queue

MIT Licensed | Made by the Remult team with ❤️