feat(client): subscribe to status

[drochetti]

subscribeToStatus API

The fal.queue.subscribeToStatus(endpointId, options) exposes the polling (or streaming) mechanism used by fal.subscribe(endpointId, options) as an API so that users can use to manage more complex workflows, such as client/server integration.

See #59 for feature request and use case details.

How to use it

After calling fal.queue.submit() or have obtained a requestId submitted to fal some other way (e.g. in your server), call fal.queue.subscribeToStatus() to listen to queue status updates until it's done:

const { requestId } = await fal.queue.submit("my/endpoint");

await fal.queue.subscribeToStatus("my/endpoint", {
  requestId,
  onQueueUpdate(update) {
    console.log(update.status);
  }
});

//  it's all done, you can fetch the result now
const result = await fal.queue.result("my/endpoint", { requestId });