Methods

(async) factory(pkgName) → {WaibuDb}

Plugin factory.

Never call this function directly!!! It's only-meant to be called by the Bajo framework during plugin initialization.

Parameters:
NameTypeDescription
pkgNamestring

NPM package name

Source
Returns:

WaibuDb class

Type: 
WaibuDb

Type Definitions

TConfig

Configuration object

Type:
  • object
Properties
NameTypeAttributesDefaultDescription
waibuobject<optional>
{}

Waibu configuration

Properties
NameTypeAttributesDefaultDescription
prefixstring<optional>
'db'

Waibu prefix

titlestring<optional>
'dbModels'

Waibu title

waibuAdminobject<optional>
{}

Waibu Admin configuration

Properties
NameTypeAttributesDefaultDescription
menuCollapsibleboolean<optional>
true

Whether the menu is collapsible

menuHandlerstring<optional>
'waibuDb:adminMenu'

Menu handler

waibuMpaobject<optional>
{}

Waibu MPA configuration

Properties
NameTypeAttributesDefaultDescription
iconstring<optional>
'database'

Icon for the MPA

dbModelobject<optional>
{}

Database model configuration

Properties
NameTypeAttributesDefaultDescription
countboolean<optional>
false

Whether to count records

patchEnabledboolean<optional>
false

Whether patching is enabled

controlobject<optional>
{}

Control configuration

Properties
NameTypeAttributesDefaultDescription
wdbBtnColumnsobject<optional>
{}

Configuration for the WDB button columns

Properties
NameTypeAttributesDefaultDescription
menuMaxnumber<optional>
10

Maximum number of menu items

enableRestApiForModelboolean<optional>
false

Whether to enable REST API for the model

Source