Preparing search index...
The search index is not available
Forest Admin - API reference
Forest Admin - API reference
@forestadmin/agent
BaseAction
Interface BaseAction<S, N, Scope, Context>
Type Parameters
S
extends
TSchema
N
extends
TCollectionName
<
S
>
Scope
extends
ActionScope
Context
extends
ActionContext
<
S
,
N
>
Hierarchy
BaseAction
Index
Properties
description?
form?
generate
File?
scope
submit
Button
Label?
Methods
execute
Properties
Optional
description
description
?:
string
Optional
form
form
?:
DynamicForm
<
Context
>
|
(
(
context
:
Context
)
=>
DynamicForm
<
Context
>
|
Promise
<
DynamicForm
<
Context
>
>
)
Optional
generate
File
generate
File
?:
boolean
scope
scope
:
Scope
Optional
submit
Button
Label
submit
Button
Label
?:
string
Methods
execute
execute
(
context
:
Context
, resultBuilder
:
default
)
:
void
|
Promise
<
void
>
|
ActionResult
|
Promise
<
ActionResult
>
Parameters
context:
Context
resultBuilder:
default
Returns
void
|
Promise
<
void
>
|
ActionResult
|
Promise
<
ActionResult
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Modules
Forest
Admin -
API reference
@forestadmin/agent
@forestadmin/datasource-
customizer
@forestadmin/datasource-
mongoose
@forestadmin/datasource-
sequelize
@forestadmin/datasource-
sql
@forestadmin/datasource-
toolkit
@forestadmin/plugin-
aws-
s3
@forestadmin/plugin-
export-
advanced
Base
Action
description?
form?
generate
File?
scope
submit
Button
Label?
execute