The class representing a streaming response. With t
+Gets the AbortSignal instance that can be used to listen for abort events.
Gets the AbortSignal instance that can be used to listen for abort events.
the AbortSignal instance.
Aborts the streaming request.
Note: This method is noop in case the request is already done.
Optionalreason: string | Erroroptional cause for aborting the request.
-Gets a reference to the Promise that indicates whether the streaming
is done or not. Developers should always call this in their apps to ensure
the request is over.
An alternative to this, is to use on('done') in case your application
architecture works best with event listeners.
the promise that resolves when the request is done.
-Creates a new reference of the FalClient.
Setup a execution chain of middleware functions.
+Setup a execution chain of middleware functions.
Rest...middlewares: RequestMiddleware[]one or more middleware functions.
a middleware function that executes the given middlewares in order.
-The main client type, it provides access to simple API model usage, +
The main client type, it provides access to simple API model usage,
as well as access to the queue and storage APIs.
ReadonlyqueueThe queue client to interact with the queue API.
-ReadonlyrealtimeThe realtime client to interact with the realtime API +
ReadonlyrealtimeThe realtime client to interact with the realtime API and receive updates in real-time.
ReadonlystorageThe storage client to interact with the storage API.
-Calls a fal app that supports streaming and provides a streaming-capable +
ReadonlystorageThe storage client to interact with the storage API.
+Calls a fal app that supports streaming and provides a streaming-capable
object as a result, that can be used to get partial results through either
AsyncIterator or through an event listener.
Calls a fal app that supports streaming and provides a streaming-capable @@ -28,13 +28,13 @@
the endpoint id, e.g. fal-ai/llavav15-13b.
the request options, including the input payload.
the FalStream instance.
ReadonlystreamingThe streaming client to interact with the streaming API.
+ReadonlystreamingThe streaming client to interact with the streaming API.
Subscribes to updates for a specific request in the queue.
+Subscribes to updates for a specific request in the queue.
The ID of the API endpoint.
Options to configure how the request is run and how updates are received.
A promise that resolves to the result of the request once it's completed.
-Represents a request queue with methods for submitting requests, +
Represents a request queue with methods for submitting requests, checking their status, retrieving results, and subscribing to updates.
-Retrieves the result of a specific request from the queue.
The ID of the function web endpoint.
Options to configure how the request is run.
A promise that resolves to the result of the request.
-Retrieves the status of a specific request in the queue.
+Retrieves the status of a specific request in the queue.
The ID of the function web endpoint.
Options to configure how the request is run.
A promise that resolves to the status of the request.
-Subscribes to updates for a specific request in the queue using HTTP streaming events.
+Subscribes to updates for a specific request in the queue using HTTP streaming events.
The ID of the function web endpoint.
Options to configure how the request is run and how updates are received.
The streaming object that can be used to listen for updates.
-Submits a request to the queue.
+Submits a request to the queue.
A promise that resolves to the result of enqueuing the request.
-Subscribes to updates for a specific request in the queue using polling or streaming. +
Subscribes to updates for a specific request in the queue using polling or streaming.
See options.mode for more details.
The ID of the function web endpoint.
Options to configure how the request is run and how updates are received.
A promise that resolves to the final status of the request.
-Connect to the realtime endpoint. The default implementation uses WebSockets to connect to fal function endpoints that support WSS.
the app alias or identifier.
the connection handler.
-File support for the client. This interface establishes the contract for +
File support for the client. This interface establishes the contract for uploading files to the server and transforming the input to replace file objects with URLs.
-Transform the input to replace file objects with URLs. This is used to transform the input before sending it to the server and ensures that the server receives URLs instead of file objects.
Upload a file to the server. Returns the URL of the uploaded file.
+Upload a file to the server. Returns the URL of the uploaded file.
The streaming client interface.
-The streaming client interface.
+Calls a fal app that supports streaming and provides a streaming-capable
object as a result, that can be used to get partial results through either
AsyncIterator or through an event listener.
the FalStream instance.
Represents an API result, containing the data, +
The function input and other configuration when running +
The function input and other configuration when running the function, such as the HTTP method to use.
Optional Readonlyinput?: InputThe function input. It will be submitted either as query params
or the body payload, depending on the method.
Optional Readonlymethod?: The HTTP method, defaults to post;
Optionalpath?: stringThe path to append to the function URL.
+Optionalpath?: stringThe path to append to the function URL.
Optional Readonlyquery?: Record<string, string>The query parameters to include in the URL.
Optional Readonlysubdomain?: stringIf true, the function will use the queue to run the function
asynchronously and return the result in a separate call. This
influences how the URL is built.
Represents the response from a WebHook request. +
Represents the response from a WebHook request.
This is a union type that varies based on the status property.
The type of the payload in the response. It defaults to any,
allowing for flexibility in specifying the structure of the payload.
The payload of the response, structure determined by the Payload type.
The unique identifier for the request.
Indicates an unsuccessful response.
-ConstCreates a singleton instance of the client. This is useful as a compatibility +
ConstCreates a singleton instance of the client. This is useful as a compatibility layer for existing code that uses the clients version prior to 1.0.0.
-
The class representing a streaming response. With t
-