IAdminForth
Properties
activatedPlugins
activatedPlugins:
IAdminForthPlugin[]
auth
auth:
IAdminForthAuth
codeInjector
codeInjector:
ICodeInjector
config
config:
AdminForthConfig
connectors
connectors:
object
Index Signature
[key: string]: IAdminForthDataSourceConnectorBase
express
express:
IExpressHttpServer
openApi
openApi:
IOpenApiRegistry
restApi
restApi:
IAdminForthRestAPI
runningHotReload
runningHotReload:
boolean
Internal flag which indicates if AdminForth is running in hot reload mode.
statuses
statuses:
object
dbDiscover
dbDiscover:
"running"|"done"
websocket
websocket:
IWebSocketBroker
Methods
bundleNow()
bundleNow(
__namedParameters):Promise<void>
Bundles AdminForth SPA by injecting custom components into internal pre-made SPA source code. It generates internally dist which then will be served by AdminForth HTTP adapter. Bundle is generated in /tmp folder so if you have ramfs or tmpfs this operation will be faster.
We recommend calling this method from dedicated script which will be run by CI/CD pipeline in build time. This ensures lowest downtime for your users. However for simple setup you can call it from your main script, and users will see some "AdminForth is bundling" message in the admin panel while app is bundling.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { buildTime: boolean; hotReload: boolean; } |
__namedParameters.buildTime | boolean |
__namedParameters.hotReload | boolean |
Returns
Promise<void>
createResourceRecord()
createResourceRecord(
params):Promise<CreateResourceRecordResult>
Parameters
| Parameter | Type |
|---|---|
params | CreateResourceRecordParams |
Returns
Promise<CreateResourceRecordResult>
deleteResourceRecord()
deleteResourceRecord(
params):Promise<DeleteResourceRecordResult>
Parameters
| Parameter | Type |
|---|---|
params | DeleteResourceRecordParams |
Returns
Promise<DeleteResourceRecordResult>
discoverDatabases()
discoverDatabases():
Promise<void>
Connects to databases defined in datasources and fetches described resource columns to find out data types and constraints. You must call this method as soon as possible after AdminForth class is instantiated.
Returns
Promise<void>
formatAdminForth()
formatAdminForth():
string
Returns
string
getMenuContributions()
getMenuContributions():
AdminForthMenuContribution[]
Returns
getMenuWithContributions()
getMenuWithContributions(
adminUser?,menu?):Promise<AdminForthConfigMenuItem[]>
Parameters
| Parameter | Type |
|---|---|
adminUser? | AdminUser |
menu? | AdminForthConfigMenuItem[] |
Returns
Promise<AdminForthConfigMenuItem[]>
getPluginByClassName()
getPluginByClassName<
T>(className):T
This method can be used when you want to get some plugin instance by class name. Should be called only if you are sure there is only one plugin instance with this class name. If several instances are found, this method will drop error.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
className | string | name of class which is used to identify plugin instance Example: const i18nPlugin = adminforth.getPluginByClassName\<I18nPlugin\>('I18nPlugin'); |
Returns
T
getPluginById()
getPluginById<
T>(id):T
This method can be used when you want to get a plugin instance by its unique identifier.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | unique id of the plugin instance (custom identifier passed when registering/configuring the plugin) Example: const auditLog = adminforth.getPluginById<AuditLogPlugin>('AuditLogPlugin'); |
Returns
T
getPluginsByClassName()
getPluginsByClassName<
T>(className):T[]
This method can be used when you want to get some plugin instances by class name. Should be used for plugins which might have multiple instances with the same class name.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
className | string | name of class which is used to identify plugin instance |
Returns
T[]
refreshMenu()
refreshMenu(
adminUser):Promise<void>
Parameters
| Parameter | Type |
|---|---|
adminUser | AdminUser |
Returns
Promise<void>
refreshMenuBadge()
refreshMenuBadge(
menuItemId,adminUser):Promise<void>
Parameters
| Parameter | Type |
|---|---|
menuItemId | string |
adminUser | AdminUser |
Returns
Promise<void>
registerMenuContribution()
registerMenuContribution(
contribution):void
Parameters
| Parameter | Type |
|---|---|
contribution | AdminForthMenuContribution |
Returns
void
registerMenuContributionProvider()
registerMenuContributionProvider(
provider):void
Parameters
| Parameter | Type |
|---|---|
provider | AdminForthMenuContributionProvider |
Returns
void
resource()
resource(
resourceId):IOperationalResource
Resource to get access to operational resources for data api fetching and manipulation.
Parameters
| Parameter | Type |
|---|---|
resourceId | string |
Returns
setupEndpoints()
setupEndpoints(
server):void
This method will be automatically called from AdminForth HTTP adapter to serve AdminForth SPA.
Parameters
| Parameter | Type |
|---|---|
server | IHttpServer |
Returns
void
tr()
tr(
msg,category,lang,params,pluralizationNumber?):Promise<string>
Parameters
| Parameter | Type |
|---|---|
msg | string |
category | string |
lang | string |
params | any |
pluralizationNumber? | number |
Returns
Promise<string>
updateResourceRecord()
updateResourceRecord(
params):Promise<UpdateResourceRecordResult>
Parameters
| Parameter | Type |
|---|---|
params | UpdateResourceRecordParams |
Returns
Promise<UpdateResourceRecordResult>