Type Alias FetchStaticState<TControllers, TSearchAction, TControllersStaticState, TControllersProps, TControllersDefinitionsMap, TSolutionType>

Type Parameters

• TControllers extends ControllersMap
• TSearchAction extends UnknownAction
• TControllersStaticState extends ControllerStaticStateMap
• TControllersProps extends ControllersPropsMap
• TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>
• TSolutionType extends SolutionType

• FetchStaticState(
      ...params: OptionsTuple<
          OptionalEngineDefinitionControllersPropsOption<
              TControllersDefinitionsMap,
              TControllersProps,
              TSolutionType,
          > & RequiredEngineDefinitionControllersPropsOption<
              TControllersDefinitionsMap,
              TControllersProps,
              TSolutionType,
          >,
      >,
  ): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>

  Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.

  Useful for static generation and server-side rendering.

  Parameters

  • ...params: OptionsTuple<
        OptionalEngineDefinitionControllersPropsOption<
            TControllersDefinitionsMap,
            TControllersProps,
            TSolutionType,
        > & RequiredEngineDefinitionControllersPropsOption<
            TControllersDefinitionsMap,
            TControllersProps,
            TSolutionType,
        >,
    >

  Returns Promise<EngineStaticState<TSearchAction, TControllersStaticState>>