Function useExportMutation

packages/vue/examples/streamMutation.ts:58–72

()

// ---------------------------------------------------------------------------

export const useExportMutation = () => {
  /**
   * `result`   - reactive ref, always reflects the latest stream event.
   *              `AsyncResult` tag:
   *                - Initial (waiting=true)  - operation in progress
   *                - Success (waiting=true)  - progress update received, still running
   *                - Success (waiting=false) - final result, operation complete
   *                - Failure                 - operation failed
   *
   * `execute`  - call with the desired `total` to kick off the stream.
   */
  const [result, execute] = asStreamResult((total: S.NonNegativeInt) => makeExportStream(total))

  return { result, execute }
}