Interface Options

Options accepted by apiker.init().

interface Options {
    adminPanel?: boolean;
    authRoutes?: boolean;
    controllers?: Controllers;
    ctx?: any;
    debug?: boolean;
    email?: EmailOptions;
    env?: any;
    exports?: any;
    firewall?: boolean | Firewall;
    name?: string;
    objectStateMapping?: ObjectStateMapping;
    objectVersion?: string;
    objects?: string[];
    requestParams?: RequestParams;
    routes?: Routes;
    scheduled?: ((params) => Promise<void>);
}

Properties

adminPanel? authRoutes? controllers? ctx? debug? email? env? exports? firewall? name? objectStateMapping? objectVersion? objects? requestParams? routes? scheduled?

Properties

Optional adminPanel

adminPanel?: boolean

Enable the built-in admin panel routes (/admp*). Defaults to false.

Optional authRoutes

authRoutes?: boolean

Enable the built-in /auth/* routes. Defaults to false.

Optional controllers

controllers?: Controllers

Controller classes referenced by string routes.

Optional ctx

ctx?: any

Worker execution context (set per request).

Optional debug

debug?: boolean

Enable verbose logging and pretty-printed JSON responses.

Optional email

email?: EmailOptions

Transactional email configuration.

Optional env

env?: any

Worker environment bindings (set per request).

Optional exports

exports?: any

The Worker's exports object; Apiker attaches handlers and DO classes to it.

Optional firewall

firewall?: boolean | Firewall

Enable the request firewall; true for defaults or an object to configure it.

Optional name

name?: string

Application name. Defaults to "Apiker".

Optional objectStateMapping

objectStateMapping?: ObjectStateMapping

Per-object rule for deriving the Durable Object instance id.

Optional objectVersion

objectVersion?: string

Durable Object schema version tag.

Optional objects

objects?: string[]

Durable Object class names to generate and export.

Optional requestParams

requestParams?: RequestParams

Current request context (set per request).

Optional routes

routes?: Routes

Route pattern → handler function or "Controller.method" string.

Optional scheduled

scheduled?: ((params) => Promise<void>)

Handler invoked on scheduled (cron) events.

Type declaration

    • (params): Promise<void>

    • Handler invoked on scheduled (cron) events.

      Parameters

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc