Interface FieldActionCreators

The field action creators.

interface FieldActionCreators {
    disableFetchAllFields(): { payload: void; type: string };
    enableFetchAllFields(): { payload: void; type: string };
    fetchFieldsDescription(): AsyncThunkAction<
        FieldDescription[],
        void,
        AsyncThunkSearchOptions<ConfigurationSection>,
    >;
    registerFieldsToInclude(
        fields: string[],
    ): { payload: string[]; type: string };
}

Methods

disableFetchAllFields enableFetchAllFields fetchFieldsDescription registerFieldsToInclude

Methods

disableFetchAllFields

  • disableFetchAllFields(): { payload: void; type: string }

  • Disable fetch all fields from the index.

    Returns { payload: void; type: string }

    A dispatchable action.

enableFetchAllFields

  • enableFetchAllFields(): { payload: void; type: string }

  • Enable fetch all fields from the index.

    This should not be used in any production environment, as it can have a negative impact on query execution time.

    Should be used for debugging purposes.

    Returns { payload: void; type: string }

    A dispatchable action.

fetchFieldsDescription

  • fetchFieldsDescription(): AsyncThunkAction<
        FieldDescription[],
        void,
        AsyncThunkSearchOptions<ConfigurationSection>,
    >

  • Fetch field descriptions from the index.

    Returns AsyncThunkAction<
        FieldDescription[],
        void,
        AsyncThunkSearchOptions<ConfigurationSection>,
    >

    A dispatchable action.

registerFieldsToInclude

  • registerFieldsToInclude(fields: string[]): { payload: string[]; type: string }

  • Registers the fields to include in the query response.

    Parameters

    • fields: string[]

      The target fields (e.g., ["field1", "field2"]).

    Returns { payload: string[]; type: string }

    A dispatchable action.

Settings

Member Visibility

On This Page

Methods