Interface SSREffectOptions

src/ssr/express.ts:23–43

}

interface SSREffectOptions<Payload> {
  /**
   * Function used to get effect payload.
   *
   * if SKIP_SYMBOL returned(`return skip()`), effect won't get dispatched when SSR
   *
   * @param req express request object
   * @param skip get a symbol used to let effect escape from ssr effects dispatching
   */
  payloadGetter?: (
    req: Request,
    skip: () => typeof SKIP_SYMBOL,
  ) => Payload | Promise<Payload> | typeof SKIP_SYMBOL

  /**
   * Whether skip first effect dispatching in client if effect ever got dispatched when SSR
   *
   * @default true
   */
  skipFirstClientDispatch?: boolean
}

// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function SSREffect<T, Payload>(options?: SSREffectOptions<Payload>) {