Forest Admin - API reference
    Preparing search index...

    Interface BaseAction<S, N, Scope, Context>

    interface BaseAction<
        S extends TSchema,
        N extends TCollectionName<S>,
        Scope extends ActionScope,
        Context extends ActionContext<S, N>,
    > {
        description?: string;
        form?:
            | DynamicForm<Context>
            | (
                (
                    context: Context,
                ) => DynamicForm<Context> | Promise<DynamicForm<Context>>
            );
        generateFile?: boolean;
        scope: Scope;
        submitButtonLabel?: string;
        execute(
            context: Context,
            resultBuilder: ResultBuilder,
        ): void | Promise<void> | ActionResult | Promise<ActionResult>;
    }

    Type Parameters

    Index

    Properties

    description? form? generateFile? scope submitButtonLabel?

    Methods

    execute

    Properties

    description?: string
    form?:
        | DynamicForm<Context>
        | (
            (
                context: Context,
            ) => DynamicForm<Context> | Promise<DynamicForm<Context>>
        )
    generateFile?: boolean
    scope: Scope
    submitButtonLabel?: string

    Methods

    • Parameters

      • context: Context
      • resultBuilder: ResultBuilder

      Returns void | Promise<void> | ActionResult | Promise<ActionResult>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods