Skip to content

@banana-universe/bananajs


@banana-universe/bananajs / CreateBananaApplicationOptions

Interface: CreateBananaApplicationOptions

Defined in: packages/bananajs/src/lib/Core/App.ts:611

Options for createBananaApplication — extends BananaAppOptions with optional listen helpers.

Extends

Properties

abac?

optional abac?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:109

guard

guard: AbacGuard

Inherited from

BananaAppOptions.abac


apiPrefix?

optional apiPrefix?: string

Defined in: packages/bananajs/src/lib/Core/App.ts:68

Prepended to every controller base path (e.g. v1/v1/...). Use URI versioning per enterprise DX docs.

Inherited from

BananaAppOptions.apiPrefix


auth?

optional auth?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:75

guard

guard: AuthGuard

Inherited from

BananaAppOptions.auth


bodyLimit?

optional bodyLimit?: string

Defined in: packages/bananajs/src/lib/Core/App.ts:60

Maximum request body size accepted by the JSON and URL-encoded body parsers. Uses the same format as the bytes package (e.g. '1mb', '500kb'). Defaults to '1mb'.

Inherited from

BananaAppOptions.bodyLimit


cache?

optional cache?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:100

store?

optional store?: "memory" | CacheStore

Inherited from

BananaAppOptions.cache


container?

optional container?: DependencyContainer

Defined in: packages/bananajs/src/lib/Core/App.ts:64

Root tsyringe container; optional — created when using modules without an explicit container.

Inherited from

BananaAppOptions.container


devTools?

optional devTools?: boolean

Defined in: packages/bananajs/src/lib/Core/App.ts:103

Inherited from

BananaAppOptions.devTools


gracefulShutdown?

optional gracefulShutdown?: boolean

Defined in: packages/bananajs/src/lib/Core/App.ts:73

Inherited from

BananaAppOptions.gracefulShutdown


health?

optional health?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:93

checks?

optional checks?: HealthCheck[]

enabled

enabled: boolean

path?

optional path?: string

Inherited from

BananaAppOptions.health


hostname?

optional hostname?: string

Defined in: packages/bananajs/src/lib/Core/App.ts:614


lazyControllers?

optional lazyControllers?: boolean

Defined in: packages/bananajs/src/lib/Core/App.ts:113

Inherited from

BananaAppOptions.lazyControllers


logger?

optional logger?: false | Logger

Defined in: packages/bananajs/src/lib/Core/App.ts:62

Inherited from

BananaAppOptions.logger


metrics?

optional metrics?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:104

enabled

enabled: boolean

path?

optional path?: string

Inherited from

BananaAppOptions.metrics


middlewares?

optional middlewares?: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]

Defined in: packages/bananajs/src/lib/Core/App.ts:51

Inherited from

BananaAppOptions.middlewares


onListening?

optional onListening?: (info) => void

Defined in: packages/bananajs/src/lib/Core/App.ts:615

Parameters

info
hostname?

string

port

number

Returns

void


plugins?

optional plugins?: BananaPlugin[]

Defined in: packages/bananajs/src/lib/Core/App.ts:99

Inherited from

BananaAppOptions.plugins


port?

optional port?: number

Defined in: packages/bananajs/src/lib/Core/App.ts:613

When set, calls Application.listen after the app is created.


rateLimit?

optional rateLimit?: false | { max?: number; message?: string; windowMs?: number; }

Defined in: packages/bananajs/src/lib/Core/App.ts:86

Inherited from

BananaAppOptions.rateLimit


requestId?

optional requestId?: boolean

Defined in: packages/bananajs/src/lib/Core/App.ts:61

Inherited from

BananaAppOptions.requestId


security?

optional security?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:52

cors?

optional cors?: false | CorsOptions

helmet?

optional helmet?: boolean | Readonly<HelmetOptions>

Inherited from

BananaAppOptions.security


swagger?

optional swagger?: object

Defined in: packages/bananajs/src/lib/Core/App.ts:78

description?

optional description?: string

enabled?

optional enabled?: boolean

Defaults to true — omit or set to false to disable.

path?

optional path?: string

title?

optional title?: string

version?

optional version?: string

Inherited from

BananaAppOptions.swagger


tenant?

optional tenant?: TenantOptions

Defined in: packages/bananajs/src/lib/Core/App.ts:112

Inherited from

BananaAppOptions.tenant


testOverrides?

optional testOverrides?: BananaProviderRegistration[]

Defined in: packages/bananajs/src/lib/Core/App.ts:72

Applied to the root container after plugin/module setup — for tests (e.g. swap a repository port for a fake).

Inherited from

BananaAppOptions.testOverrides

Released under the MIT License.