Class Apiker

Apiker class definition. ⚠️ Please do not instantiate this class and use the "apiker" exported instance instead.

Constructors

constructor

Properties

adminPanel authRoutes controllers ctx debug defaultObjectName email? env firewall name objectStateMapping objectVersion objects requestParams responseHeaders responseParams routes timings

Methods

getObjectClassDefinition init setProps

Constructors

constructor

Properties

adminPanel

adminPanel: boolean

authRoutes

authRoutes: boolean

controllers

controllers: Controllers = {}

ctx

ctx: any

debug

debug: boolean = false

defaultObjectName

defaultObjectName: string = "Common"

Optional email

email?: EmailOptions

env

env: any

firewall

firewall: boolean | Firewall

name

name: string = "Apiker"

objectStateMapping

objectStateMapping: ObjectStateMapping

objectVersion

objectVersion: string = "V1"

objects

objects: string[]

requestParams

requestParams: RequestParams

responseHeaders

responseHeaders: Headers

responseParams

responseParams: ResponseParams = ...

routes

routes: Routes = {}

timings

timings: Timings = {}

Methods

getObjectClassDefinition

  • getObjectClassDefinition(objectName): typeof __class

  • Creates a durable object class definition

    Parameters

    • objectName: string

    Returns typeof __class

init

setProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc