From 55a550a815c074b3ff9e2151245bfa3e7bbc3205 Mon Sep 17 00:00:00 2001 From: Matteo Ferrando Date: Tue, 26 Nov 2024 10:38:04 -0400 Subject: [PATCH] chore: add docs --- docs/reference/assets/navigation.js | 2 +- docs/reference/assets/search.js | 2 +- docs/reference/classes/ApiError.html | 4 -- docs/reference/classes/FalStream.html | 24 ----------- docs/reference/classes/ValidationError.html | 6 --- docs/reference/functions/createFalClient.html | 4 -- .../functions/createStorageClient.html | 1 + .../functions/isCompletedQueueStatus.html | 1 - docs/reference/functions/isQueueStatus.html | 1 - docs/reference/functions/parseEndpointId.html | 1 - docs/reference/functions/withMiddleware.html | 4 -- docs/reference/functions/withProxy.html | 1 - docs/reference/hierarchy.html | 1 - docs/reference/index.html | 30 +------------- .../interfaces/CompletedQueueStatus.html | 6 --- docs/reference/interfaces/FalClient.html | 40 ------------------- .../interfaces/InProgressQueueStatus.html | 5 --- .../interfaces/InQueueQueueStatus.html | 5 --- docs/reference/interfaces/QueueClient.html | 36 ----------------- docs/reference/interfaces/RealtimeClient.html | 6 --- docs/reference/interfaces/StorageClient.html | 6 +-- .../reference/interfaces/StreamingClient.html | 9 ----- docs/reference/types/Metrics.html | 1 - docs/reference/types/QueueStatus.html | 1 - docs/reference/types/RequestLog.html | 1 - docs/reference/types/RequestMiddleware.html | 1 - docs/reference/types/ResponseHandler.html | 1 - docs/reference/types/Result.html | 3 -- docs/reference/types/RunOptions.html | 6 --- docs/reference/types/UrlOptions.html | 6 --- docs/reference/types/ValidationErrorInfo.html | 1 - docs/reference/types/WebHookResponse.html | 13 ------ docs/reference/variables/fal.html | 3 -- 33 files changed, 8 insertions(+), 224 deletions(-) delete mode 100644 docs/reference/classes/ApiError.html delete mode 100644 docs/reference/classes/FalStream.html delete mode 100644 docs/reference/classes/ValidationError.html delete mode 100644 docs/reference/functions/createFalClient.html create mode 100644 docs/reference/functions/createStorageClient.html delete mode 100644 docs/reference/functions/isCompletedQueueStatus.html delete mode 100644 docs/reference/functions/isQueueStatus.html delete mode 100644 docs/reference/functions/parseEndpointId.html delete mode 100644 docs/reference/functions/withMiddleware.html delete mode 100644 docs/reference/functions/withProxy.html delete mode 100644 docs/reference/hierarchy.html delete mode 100644 docs/reference/interfaces/CompletedQueueStatus.html delete mode 100644 docs/reference/interfaces/FalClient.html delete mode 100644 docs/reference/interfaces/InProgressQueueStatus.html delete mode 100644 docs/reference/interfaces/InQueueQueueStatus.html delete mode 100644 docs/reference/interfaces/QueueClient.html delete mode 100644 docs/reference/interfaces/RealtimeClient.html delete mode 100644 docs/reference/interfaces/StreamingClient.html delete mode 100644 docs/reference/types/Metrics.html delete mode 100644 docs/reference/types/QueueStatus.html delete mode 100644 docs/reference/types/RequestLog.html delete mode 100644 docs/reference/types/RequestMiddleware.html delete mode 100644 docs/reference/types/ResponseHandler.html delete mode 100644 docs/reference/types/Result.html delete mode 100644 docs/reference/types/RunOptions.html delete mode 100644 docs/reference/types/UrlOptions.html delete mode 100644 docs/reference/types/ValidationErrorInfo.html delete mode 100644 docs/reference/types/WebHookResponse.html delete mode 100644 docs/reference/variables/fal.html diff --git a/docs/reference/assets/navigation.js b/docs/reference/assets/navigation.js index f47e6b4..5720655 100644 --- a/docs/reference/assets/navigation.js +++ b/docs/reference/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE43UXU/CMBQG4P/Sa+IUBZU7QzCQSESJemG8OG5n0NC1sz3zI8b/bpzKaNe13PK+58l2Ovr4yQjfiY3YRcknWivNeqwEWrMRSwUYgyb5Tw7WVAjWYxsuMzY66p999bbTlyCWpBGK9vg2Cs3fg+AZEFey4yGcQsgaq6IUSJjdVFjhkoAq04BcEuocUjSJr2jD/cHQfsmx4CjJq23TEDGTC61WGo2JPZy3GabrYtx1ayG0rgVeeicPMbcIgngRkuxKCFuS0rAKWVYjTP18mFyugpjVCXFzJM3Tnb3TR4km+fvZmTw8Pz0a9N1duyf3K3SfVku5xZcKDV2plYs0yZ7GnGeZwDfQ2EE1hbhoSiUNTkFmAnXbs+I9tEqQB6mEez7t2Upelz/3SGvJTRIz7rToMJokZjgX2kzmysU8lZj6gM9TpTb/+3RFJ45pOYhGeAXN4VmgSXIQ9uTx7lCqEQg9d2VeybReTeJUbGx4soNxE77NG9PfDNJRcT+oBG1wIrNScUmzzEc5lQD2xmnt+981lt2IUAut3j+6lDpsAU/fB9L83BQIAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE4uuVipJrShRslIKLskvSkxPdc7JTM0rUdJRKkgsyQAKZ+aVpBalJSanFuujqNDLKMnNASrLzsxLUbIyMjWr1YEblVyUmliSisPAtNK85JLM/LxifSzKUE01M6mNBQBnlcSUoQAAAA==" \ No newline at end of file diff --git a/docs/reference/assets/search.js b/docs/reference/assets/search.js index 17433e7..c3e19ce 100644 --- a/docs/reference/assets/search.js +++ b/docs/reference/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72cWY/bRhKA/wv9KsvTJ8l5WwQJYmCDzSa72QfBGHAkzpiIhlRIyl7D8H9fNA+xilUtNjXGPo0tdh1d/VX1weNrVFefm+h+9zX6sygP0b2Sm6jMXvLoPnrKjtEmOtfH6D76lNVF9njMm3dP2XH7sX1xl/bHrGnyJrqPom+bUYHVFwX7Os/a/Kfs+MOxyMv2ouzpXO7boiqbd7MWVxVLYy+aqc6ibPP6KdvnzbswdeJOTp7+dc7P+bKuN2M7oHETnbLaeQK98pip8+zYFi8hlkDTG401bVVnzyG2ppY3m6rz7KUon4OMTW3Dzck7nUxhPJchEexa3WiiOT82+7p4DAofaPuqAAZHb5Uha4yaMufhof1yCoPCWdpe2i8Y3A6esYXgc9F+/KU4HI7556zOmTqAG4TWFyf1a13994tHY3ftek25S2NhppL3W/7XOW9axlcXheYduX7d1WuRv6bwzULUqZt8mfynK1f+QgkuL0QJZ8ZLEaTuzaUp3wvonc9Ym7XnJszY2PQVxhzBv68xiQRuNzwWkH9Va6wzUje7UOfN+Rg2qpemNxvbZ+U+PwYZuzRdZQykwG/DPOrPAtwiPBH2VVnm+1CVb6bmvpxGjoKJQk42/3Yqfqzrqr4YHXS9Gy9cdd8ICb1v2vq8b5eUvcEteecvfnnnN4Q1b2ghg5dsPFaHLwsWXJO3cpUFEPw/smNxyNz0wo/B7Pp3GQpOZ9CIzJ0FEFsp9BS2pyI/Hro2dHxY61hgtXWYQs95+9Na80RmrQchYLKWGT7b5vC2aN4W5ce8Ltr8cIMHLLas/aHla63TNU9zqsom/zkrD8e8JgsUdPX16x2qbnm1gx3kC/3v/SbGX+dRg/Ct4fl0rLJDmMI3l8Z8T7CP65foXovDMv1KbcOig5+eLrd1VjZPVf3yvjydA2P5hgj930KALS/tWLCCmdd84f8pO/6ON2hjnl6ufJdij7UFlfnJNc9Y7qvyqXgOMNW3utFKXh5OVVG27w9LllDLG605Awtm+iY36q9O3R5yycbULNwOmv6qctHE1SOM69oPVZkv6R/a3Gghe6zqdsnE2GiFDbxAaYrnMlsc8EurG/uyy5ov5f59m9dZW9Uflsw9oOYP6+yiWWs4Dbs2b6EmK3bq3kMlTuXS0dLcU/+CotuUzTay/ewPrqw6lpktZt6XT9VMM9PitUsVn8ql5QrnrKfQvDTP64xue4lgw+Nk6LF/rPYr7fcS38v++qhv14aeejCH6z/5489V9ee4ypz5M7saejR5yuom/5HOitMB5axFqOKi4dJrUouuhyv9oXo5HfM2Pyxp5xquPGJFJ02XbcH5eL20hW0uRi0BewrnhYfLQ9Zmi7q3Q6trBhb4r/tzXMCH1xhsus4iGYBz+Y/ZAmewernw6oHAmhYHY/LIE6gCbUSuGdl2Td+KAGMLg/OStx8rMjK80Uvb9Tbnw/Pv+sgPz3ThtcMz07Q0PMAj3ynK+fFQvWRFGWRoC5svmVwYpL/Oef0lzOrY9JUWT1n7Mczg0HK9Pc9dqb9X89XCdOE73YcaNQXegHIeebOnaeDd52tmtlPjJXNLC5r8E7ixcNXm2PSVFpvqXO8Du3lp+0qb7jZB02YvpzCzsPl6y3MYf8nbutjPi9Pw62sxhGqWGBwd8U4ZT3mdl/v8AT1x4bWzJQJXzTKBAtu692W3POIWU2AbRluFH0v674x6tC7dXmFcvvawzMOpagpXv9a4QCRf60o9LMsf4JFQgCMzude70eXPQ8GeE/udAFJhp/pXXcIA/lpXz3XesNsF5BzT8Ptg6FO8TCLn+80EeN0IhGCFM8fqeW0sBpHvEonrEF6Jww0cXncMonh1awk8XL2zDATRq3eJQ9bxGzH0OxFE4RpXfBD6XbjK4BrTL7O1QZD1Seh7DMO1HLg2CKtTgHfrwyYqykP+3+j+a/Qprxs3zd1Hcqu2abTp77W7p217fzfRvnp56Y99D9X+3P3zw9Dsj9zd+HGN+9bv7qLN7m6j5Vam6sOHzW4U7i50P4w6pl86QRFtdoITFERQIEEZbXaSE5REUCJBFW12ihNURFAhQR1tdpoT1ERQI0ETbXaGEzRE0CBBG212lhO0RNAiwTja7GJOMCaCMRJMos0u4QQTIpggwTTa7NKNirci0UgwJYIpBsDxIO42UmxTiUUFhUfM6Onw4flhAMIECceFYBkSFCKBKRKODcFyJChIApMktL/PFCaBaRKOEcGCKChQAhMlHCeChVFQqASmSjhWhN3IeGtlioUpWAKTJRwvgoVSULgEpks4ZgQLpqCACUyY7Ahj4ZSUMIkJk44ZyZY2SQmTsxrVFSkWT8mUKUyYdMxIvsRRwiQmTDpmJIunpIRJTJh0zEi9UWqbSCxLAZMYMGm9jEgKmMSASYeMNOxIUcAkBkw6ZCRbLiUFTGLAZOrtMuVLYr6UI0ayZCvKl8J8qY4vlmxF+VKYLyW9wVaULzWbB5U32IqZCjFfquMrZd2mfCnMlzLe8qcoYAoDphwyik1IRQFTGDDlkFFsQioKmMKAqcTvNgVMYcCUY0ax2awoYQoTpv1zpKaEaUyYdswothRoSpjGhGnpywtNAdMYMN2ttPgVEwVMzxZbDhnFTlSaWW9hwLRDRrGlQFPANAZMd4Cx6awpYBoDpjvA2HTWFDCNAdMOGcUmlaaAaQyYdshoNi80BUxjwIxDRrN5YShgBgNmHDKaRdtQwAwGzDhmNEunoYQZTJhRvlWnoYAZDJjplvMsnYYCZmYreoeM5tf0zKIeA2asN5sNBcxgwIxDRrNoGwqYwYAZh4xm0TYUMIMBMx1gLNqGAmYwYLYDjEXbUsAsBsw6ZAyLtqWAWQyYdcgYFm1LAbMYMOuYMSzalhJmMWFWe9edlhJmMWHWP0daSpid7RsdM4ZNKstsHTFh1jFj2MSwlDCLCbOOGcMmhqWEWUyYTf19poRZTFjsmDFsYsSUsBgTFneE8TtmSliMCYs7wtjEiClhMSYsVt4+x5SwGBMWO2YMm1UxJSzGhMWOGctmVUwJizFhcXc0wWZVTAmLZ6cTjhnLZlXMHFBgwmL/KiymhMWYsNgxY9nEiClhMSYsccxYNjESSliCCUscM5ZNjIQSlmDCEseMZdlOKGEJJixxzNiYK0MJJSzBhCX+k4qEEpZgwpKOMP44iRKWYMKSjjCW7YQSlmDCEv9JRUIJS2ZnYI6ZmE2MhDkGw4QljplYMAvmhAKWYMBSh0wsGdmU8pVivlJHTMySnVK+UsxX6t9HppSvFPOVKl+PU4pXivFKHTCxZs8NKV4pxis13nBRulJMV+p4idl0TCldKaYr9dOVUrpSTFeaeMNF4Upnh6ypP1zMOev8oPXOWwj6a1gc/DbIC1+8+0tz8f637qbDp7xu88P7/ubDbnd5vuJr9DDckRB3432Sr5G4i+6/fttEQvd/lRn+Jv1fPVw3tv9rh+s27f/Gavg7tE86Pd+mOxrdr5ebGu6ac314GWDySQOfdBqm41Tk/fuXkxqpJjUy0BX3AH8xPMCPXJKTLiOCdPVv5gF3DHAnHiKrglSNLzwDZSBEMsyf/XhvqnvgYrzNOamMgX+pDVTZvyE0KVEaDF1g58Z3oEHvQLRlsJbpvSigCfgjB1zlgKuWYZq7z9E8Zcf98DYGSB6QO0G6+qeDJwUGIGrDYt6/nQMinoKIJ0Eqxtet3I1NoAiMvw5Ll+5jQJMGwORdqDwNKhz7UC3jayqgNyCyOmxwujus+fAGMfAnnjSpsH49561PWQKUhbk1fwRtUmaBssQEKjsNz2j4qgCIWxrqYPccNqDaTjrisIgVZeePxykLGE/C0qRoluqdAaDZsCJT+KJmQCWwYdQOj5qCToJSlYRFrXvxBkxSgFQTVgr6pzzA8AMn0mEZkIZNwZfndUGXAExxqJb+oXkQW9CrOIzIy9MjwBWgJRnWKW6lFaSuQXOcBnibOEiDe64R1CaQtzpQwfj0P9ACeqTDkqJ7vYiv/gYUbxsW5f5RdhBikARxmEPD4/dAB3AjDitpw+fXQGBAiQ3XAJ5ABekA3EnCMqpTxiwVQGKJFR2jtUYDTSZsnp6+GwfUAHpWKWFmbDDwMqz6wWerQLhBSU6HzUZqxmQNo3LQPKMb9NaGZdyg51ih3LfAw3iVohfw+TCABYBVhNGKnw0EwQOjkAxL3HSodGkYu6Pqj+NXP8AYgylYhQLTv9QHeguUyGF8baCyM05MMAyh8kwNNWDNa8NiNL5TDjIJBN6EzSjjSx8ALOBJEkY6LQ0CzExi2GLKYbOuZP83GX5Ph/+nYfG7fA4SBA90e40OWkAUKLMqbOagK37A1kC/CUso8PFJMB4AjHVaaPc0SHITVh97bcwIA/BFILDTi3Vg7EC04rAMHD/cB5wBBIjAKE2fxZz0wG3MOi1txYQIqBNhi07wMhQgACCQhI3a5cMxZEukwLyhAp2andRp0C8TpmL88hDwA9QqFZb5s2lGgbDosLw/10eu9oL+xGHx/XR5lZ8e9gG3ZBhFM21F9wEJEG9Y38I6+jl//FhVf9aXrwYAbSDhbNgk4b5W6lk1wIOnsMnCKTv1n0UFegCVImAIPmyiU3HKj0WZR/e7D9++/Q9DldaaKloAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72Uy26DMBBF/2WydQk2BinZdpV1pW4QihCYFhUMMqYPIf69w9MlEJVuugFszz137BncgCo+Kjj7DbylMoazxwnIMBdwhkiJUIsnXajwRTxmqZAaCNQqw7WklpFOC1kdN6KsV51nGBplYVUJpAO0ZDJgrjc7bLNTqYVKwkhUx/1YajOTeV1mRRjvAx7m4B9cAmWoupxuczSGnus6ZifXq/4qxZ8crUHzwPZZW2Oed7asVSirpFD5RZb1zrM8rET/dgRLZ2vW7jmIm6zbgKBZLD7h3MC7UBW2JWqY5VgnhCSpyOKuw4c80aLI86Hd4iKq+89gDHsWETp1wUP00Qbi24S6Frd5EBB/EvcL/cTEMDO9kOKIbgnpSkgXQuwGn20J2UrIFkIHRw6htsVO3kLorITOQshxxLcc+UrIF0L3nqO7Eg4zfaGwQlrEl6FgeM5T6Ru4jlV0ppZqwMFHS8DtXq0pXT85V69b6+37m6gaeiUa7xSDtQ3W3sW7S6KGRHeR5o5Nh//MoLhB8V2o6bYyCGYQ7HcE1qBMS5GlEhV+0LbfK6Fb1QIGAAA="; \ No newline at end of file diff --git a/docs/reference/classes/ApiError.html b/docs/reference/classes/ApiError.html deleted file mode 100644 index 3c4e232..0000000 --- a/docs/reference/classes/ApiError.html +++ /dev/null @@ -1,4 +0,0 @@ -ApiError | @fal-ai/client

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor -

Properties

body -status -

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/reference/classes/FalStream.html b/docs/reference/classes/FalStream.html deleted file mode 100644 index 25a7f73..0000000 --- a/docs/reference/classes/FalStream.html +++ /dev/null @@ -1,24 +0,0 @@ -FalStream | @fal-ai/client

Class FalStream<Input, Output>

The class representing a streaming response. With t

-

Type Parameters

  • Input
  • Output

Constructors

constructor -

Properties

config -endpointId -options -url -

Accessors

signal -

Methods

[asyncIterator] -abort -done -on -

Constructors

constructor

Properties

config

config: Required<Config>

endpointId

endpointId: string

options

options: StreamOptions<Input>

url

url: string

Accessors

signal

Methods

[asyncIterator]

abort

  • abort(reason?): void

  • Aborts the streaming request.

    -

    Note: This method is noop in case the request is already done.

    -

    Parameters

    • Optionalreason: string | Error

      optional cause for aborting the request.

      -

    Returns void

done

  • done(): Promise<Output>

  • 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.

    -

    Returns Promise<Output>

    the promise that resolves when the request is done.

    -

on

  • on(type, listener): void

  • Parameters

    • type: FalStreamEventType
    • listener: EventHandler<any>

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/classes/ValidationError.html b/docs/reference/classes/ValidationError.html deleted file mode 100644 index cd3bb5a..0000000 --- a/docs/reference/classes/ValidationError.html +++ /dev/null @@ -1,6 +0,0 @@ -ValidationError | @fal-ai/client

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor -

Properties

body -status -

Accessors

fieldErrors -

Methods

getFieldErrors -

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/functions/createFalClient.html b/docs/reference/functions/createFalClient.html deleted file mode 100644 index b4b3915..0000000 --- a/docs/reference/functions/createFalClient.html +++ /dev/null @@ -1,4 +0,0 @@ -createFalClient | @fal-ai/client

Function createFalClient

  • createFalClient(userConfig?): FalClient

  • Creates a new reference of the FalClient.

    -

    Parameters

    • userConfig: Config = {}

      Optional configuration to override the default settings.

      -

    Returns FalClient

    a new instance of the FalClient.

    -

Settings

Member Visibility
diff --git a/docs/reference/functions/createStorageClient.html b/docs/reference/functions/createStorageClient.html new file mode 100644 index 0000000..703df8d --- /dev/null +++ b/docs/reference/functions/createStorageClient.html @@ -0,0 +1 @@ +createStorageClient | @fal-ai/client

Function createStorageClient

Settings

Member Visibility
diff --git a/docs/reference/functions/isCompletedQueueStatus.html b/docs/reference/functions/isCompletedQueueStatus.html deleted file mode 100644 index a5dfc4f..0000000 --- a/docs/reference/functions/isCompletedQueueStatus.html +++ /dev/null @@ -1 +0,0 @@ -isCompletedQueueStatus | @fal-ai/client

Function isCompletedQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/isQueueStatus.html b/docs/reference/functions/isQueueStatus.html deleted file mode 100644 index f0e801f..0000000 --- a/docs/reference/functions/isQueueStatus.html +++ /dev/null @@ -1 +0,0 @@ -isQueueStatus | @fal-ai/client

Function isQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/parseEndpointId.html b/docs/reference/functions/parseEndpointId.html deleted file mode 100644 index 5c38a2c..0000000 --- a/docs/reference/functions/parseEndpointId.html +++ /dev/null @@ -1 +0,0 @@ -parseEndpointId | @fal-ai/client

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
diff --git a/docs/reference/functions/withMiddleware.html b/docs/reference/functions/withMiddleware.html deleted file mode 100644 index 720f734..0000000 --- a/docs/reference/functions/withMiddleware.html +++ /dev/null @@ -1,4 +0,0 @@ -withMiddleware | @fal-ai/client

Function withMiddleware

Settings

Member Visibility
diff --git a/docs/reference/functions/withProxy.html b/docs/reference/functions/withProxy.html deleted file mode 100644 index 7ba52c4..0000000 --- a/docs/reference/functions/withProxy.html +++ /dev/null @@ -1 +0,0 @@ -withProxy | @fal-ai/client

Function withProxy

Settings

Member Visibility
diff --git a/docs/reference/hierarchy.html b/docs/reference/hierarchy.html deleted file mode 100644 index 043256e..0000000 --- a/docs/reference/hierarchy.html +++ /dev/null @@ -1 +0,0 @@ -@fal-ai/client

@fal-ai/client

Class Hierarchy

Settings

Member Visibility
diff --git a/docs/reference/index.html b/docs/reference/index.html index 7806e02..34fd8b1 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,29 +1,3 @@ -@fal-ai/client

@fal-ai/client

Index

Classes

ApiError -FalStream -ValidationError -

Interfaces

CompletedQueueStatus -FalClient -InProgressQueueStatus -InQueueQueueStatus -QueueClient -RealtimeClient -StorageClient -StreamingClient -

Type Aliases

Metrics -QueueStatus -RequestLog -RequestMiddleware -ResponseHandler -Result -RunOptions -UrlOptions -ValidationErrorInfo -WebHookResponse -

Variables

fal -

Functions

createFalClient -isCompletedQueueStatus -isQueueStatus -parseEndpointId -withMiddleware -withProxy +@fal-ai/client

@fal-ai/client

Index

Interfaces

StorageClient +

Functions

createStorageClient

Settings

Member Visibility
diff --git a/docs/reference/interfaces/CompletedQueueStatus.html b/docs/reference/interfaces/CompletedQueueStatus.html deleted file mode 100644 index b1e2156..0000000 --- a/docs/reference/interfaces/CompletedQueueStatus.html +++ /dev/null @@ -1,6 +0,0 @@ -CompletedQueueStatus | @fal-ai/client

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs -metrics? -request_id -response_url -status -

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/FalClient.html b/docs/reference/interfaces/FalClient.html deleted file mode 100644 index 9a658e2..0000000 --- a/docs/reference/interfaces/FalClient.html +++ /dev/null @@ -1,40 +0,0 @@ -FalClient | @fal-ai/client

Interface FalClient

The main client type, it provides access to simple API model usage, -as well as access to the queue and storage APIs.

-

See

createFalClient

-
interface FalClient {
    queue: QueueClient;
    realtime: RealtimeClient;
    storage: StorageClient;
    stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>);
    streaming: StreamingClient;
    run<Id>(endpointId: Id, options: RunOptions<InputType<Id>>): Promise<Result<OutputType<Id>>>;
    subscribe<Id>(endpointId: Id, options: RunOptions<InputType<Id>> & QueueSubscribeOptions): Promise<Result<OutputType<Id>>>;
}

Properties

queue -realtime -storage -stream -streaming -

Methods

run -subscribe -

Properties

Readonlyqueue

queue: QueueClient

The queue client to interact with the queue API.

-

Readonlyrealtime

realtime: RealtimeClient

The realtime client to interact with the realtime API -and receive updates in real-time.

-

See

    -
  • #RealtimeClient
    • -
  • #RealtimeClient.connect
    • -
-

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

-

stream

stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>)

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.

-

Type declaration

    • <Id>(endpointId, options): Promise<FalStream<InputType<Id>, OutputType<Id>>>

    • 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.

      -

      Type Parameters

      • Id extends EndpointType

      Parameters

      • endpointId: Id

        the endpoint id, e.g. fal-ai/llavav15-13b.

        -
      • options: StreamOptions<InputType<Id>>

        the request options, including the input payload.

        -

      Returns Promise<FalStream<InputType<Id>, OutputType<Id>>>

      the FalStream instance.

      -

Param: endpointId

the endpoint id, e.g. fal-ai/llavav15-13b.

-

Param: options

the request options, including the input payload.

-

Returns

the FalStream instance.

-

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

-

See

#stream

-

Methods

run

  • run<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

  • Runs a fal endpoints identified by its endpointId.

    -

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      the registered function revision id or alias.

      -
    • options: RunOptions<InputType<Id>>

    Returns Promise<Result<OutputType<Id>>>

    the remote function output

    -

subscribe

  • subscribe<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

  • Subscribes to updates for a specific request in the queue.

    -

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the API endpoint.

      -
    • options: RunOptions<InputType<Id>> & QueueSubscribeOptions

      Options to configure how the request is run and how updates are received.

      -

    Returns Promise<Result<OutputType<Id>>>

    A promise that resolves to the result of the request once it's completed.

    -

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/reference/interfaces/InProgressQueueStatus.html b/docs/reference/interfaces/InProgressQueueStatus.html deleted file mode 100644 index 8542465..0000000 --- a/docs/reference/interfaces/InProgressQueueStatus.html +++ /dev/null @@ -1,5 +0,0 @@ -InProgressQueueStatus | @fal-ai/client

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs -request_id -response_url -status -

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/InQueueQueueStatus.html b/docs/reference/interfaces/InQueueQueueStatus.html deleted file mode 100644 index afa5f4d..0000000 --- a/docs/reference/interfaces/InQueueQueueStatus.html +++ /dev/null @@ -1,5 +0,0 @@ -InQueueQueueStatus | @fal-ai/client

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position -request_id -response_url -status -

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/QueueClient.html b/docs/reference/interfaces/QueueClient.html deleted file mode 100644 index 25d79fa..0000000 --- a/docs/reference/interfaces/QueueClient.html +++ /dev/null @@ -1,36 +0,0 @@ -QueueClient | @fal-ai/client

Interface QueueClient

Represents a request queue with methods for submitting requests, -checking their status, retrieving results, and subscribing to updates.

-
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Id>(endpointId: Id, options: BaseQueueOptions): Promise<Result<any>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Id>(endpointId: Id, options: SubmitOptions<InputType<Id>>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel -result -status -streamStatus -submit -subscribeToStatus -

Methods

cancel

  • cancel(endpointId, options): Promise<void>

  • Cancels a request in the queue.

    -

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

      -
    • options: BaseQueueOptions

      Options to configure how the request -is run and how updates are received.

      -

    Returns Promise<void>

    A promise that resolves once the request is cancelled.

    -

    Throws

    If the request cannot be cancelled.

    -

result

  • result<Id>(endpointId, options): Promise<Result<any>>

  • Retrieves the result of a specific request from the queue.

    -

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the function web endpoint.

      -
    • options: BaseQueueOptions

      Options to configure how the request is run.

      -

    Returns Promise<Result<any>>

    A promise that resolves to the result of the request.

    -

status

  • status(endpointId, options): Promise<QueueStatus>

  • Retrieves the status of a specific request in the queue.

    -

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

      -
    • options: QueueStatusOptions

      Options to configure how the request is run.

      -

    Returns Promise<QueueStatus>

    A promise that resolves to the status of the request.

    -

streamStatus

  • streamStatus(endpointId, options): Promise<FalStream<unknown, QueueStatus>>

  • Subscribes to updates for a specific request in the queue using HTTP streaming events.

    -

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

      -
    • options: QueueStatusStreamOptions

      Options to configure how the request is run and how updates are received.

      -

    Returns Promise<FalStream<unknown, QueueStatus>>

    The streaming object that can be used to listen for updates.

    -

submit

  • submit<Id>(endpointId, options): Promise<InQueueQueueStatus>

  • Submits a request to the queue.

    -

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the function web endpoint.

      -
    • options: SubmitOptions<InputType<Id>>

      Options to configure how the request is run.

      -

    Returns Promise<InQueueQueueStatus>

    A promise that resolves to the result of enqueuing the request.

    -

subscribeToStatus

  • subscribeToStatus(endpointId, options): Promise<CompletedQueueStatus>

  • Subscribes to updates for a specific request in the queue using polling or streaming. -See options.mode for more details.

    -

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

      -
    • options: QueueStatusSubscriptionOptions

      Options to configure how the request is run and how updates are received.

      -

    Returns Promise<CompletedQueueStatus>

    A promise that resolves to the final status of the request.

    -

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/RealtimeClient.html b/docs/reference/interfaces/RealtimeClient.html deleted file mode 100644 index 7add32e..0000000 --- a/docs/reference/interfaces/RealtimeClient.html +++ /dev/null @@ -1,6 +0,0 @@ -RealtimeClient | @fal-ai/client

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect -

Methods

connect

  • connect<Input, Output>(app, handler): RealtimeConnection<Input>

  • Connect to the realtime endpoint. The default implementation uses -WebSockets to connect to fal function endpoints that support WSS.

    -

    Type Parameters

    • Input = any
    • Output = any

    Parameters

    • app: string

      the app alias or identifier.

      -
    • handler: RealtimeConnectionHandler<Output>

      the connection handler.

      -

    Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/StorageClient.html b/docs/reference/interfaces/StorageClient.html index 7df7e7c..e2513b5 100644 --- a/docs/reference/interfaces/StorageClient.html +++ b/docs/reference/interfaces/StorageClient.html @@ -1,14 +1,14 @@ StorageClient | @fal-ai/client

Interface StorageClient

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.

-
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput +
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput upload

Properties

transformInput

transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>)

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.

Type declaration

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

+

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

Type declaration

    • (file): Promise<string>

    • Parameters

      • file: Blob

        the file to upload

      Returns Promise<string>

      the URL of the uploaded file

      -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/StreamingClient.html b/docs/reference/interfaces/StreamingClient.html deleted file mode 100644 index e7b176f..0000000 --- a/docs/reference/interfaces/StreamingClient.html +++ /dev/null @@ -1,9 +0,0 @@ -StreamingClient | @fal-ai/client

Interface StreamingClient

The streaming client interface.

-
interface StreamingClient {
    stream<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>): Promise<FalStream<InputType<Id>, OutputType<Id>>>;
}

Methods

stream -

Methods

stream

  • stream<Id>(endpointId, options): Promise<FalStream<InputType<Id>, OutputType<Id>>>

  • 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.

    -

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      the endpoint id, e.g. fal-ai/llavav15-13b.

      -
    • options: StreamOptions<InputType<Id>>

      the request options, including the input payload.

      -

    Returns Promise<FalStream<InputType<Id>, OutputType<Id>>>

    the FalStream instance.

    -

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/types/Metrics.html b/docs/reference/types/Metrics.html deleted file mode 100644 index 960f373..0000000 --- a/docs/reference/types/Metrics.html +++ /dev/null @@ -1 +0,0 @@ -Metrics | @fal-ai/client

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
diff --git a/docs/reference/types/QueueStatus.html b/docs/reference/types/QueueStatus.html deleted file mode 100644 index e8f5a80..0000000 --- a/docs/reference/types/QueueStatus.html +++ /dev/null @@ -1 +0,0 @@ -QueueStatus | @fal-ai/client

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/types/RequestLog.html b/docs/reference/types/RequestLog.html deleted file mode 100644 index 8df4036..0000000 --- a/docs/reference/types/RequestLog.html +++ /dev/null @@ -1 +0,0 @@ -RequestLog | @fal-ai/client

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
diff --git a/docs/reference/types/RequestMiddleware.html b/docs/reference/types/RequestMiddleware.html deleted file mode 100644 index 3a2b0a9..0000000 --- a/docs/reference/types/RequestMiddleware.html +++ /dev/null @@ -1 +0,0 @@ -RequestMiddleware | @fal-ai/client

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
diff --git a/docs/reference/types/ResponseHandler.html b/docs/reference/types/ResponseHandler.html deleted file mode 100644 index aa911e3..0000000 --- a/docs/reference/types/ResponseHandler.html +++ /dev/null @@ -1 +0,0 @@ -ResponseHandler | @fal-ai/client

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
diff --git a/docs/reference/types/Result.html b/docs/reference/types/Result.html deleted file mode 100644 index 2bb0300..0000000 --- a/docs/reference/types/Result.html +++ /dev/null @@ -1,3 +0,0 @@ -Result | @fal-ai/client

Type Alias Result<T>

Result<T>: {
    data: T;
    requestId: string;
}

Represents an API result, containing the data, -the request ID and any other relevant information.

-

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/reference/types/RunOptions.html b/docs/reference/types/RunOptions.html deleted file mode 100644 index 46eb0fa..0000000 --- a/docs/reference/types/RunOptions.html +++ /dev/null @@ -1,6 +0,0 @@ -RunOptions | @fal-ai/client

Type Alias RunOptions<Input>

RunOptions<Input>: {
    input?: Input;
    method?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string;
}

The function input and other configuration when running -the function, such as the HTTP method to use.

-

Type Parameters

  • Input

Type declaration

  • Optional Readonlyinput?: Input

    The function input. It will be submitted either as query params -or the body payload, depending on the method.

    -
  • Optional Readonlymethod?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string

    The HTTP method, defaults to post;

    -

Settings

Member Visibility
diff --git a/docs/reference/types/UrlOptions.html b/docs/reference/types/UrlOptions.html deleted file mode 100644 index 603ae9c..0000000 --- a/docs/reference/types/UrlOptions.html +++ /dev/null @@ -1,6 +0,0 @@ -UrlOptions | @fal-ai/client

Type Alias UrlOptions

UrlOptions: {
    path?: string;
    query?: Record<string, string>;
    subdomain?: string;
}

Type declaration

  • Optionalpath?: string

    The path to append to the function URL.

    -
  • Optional Readonlyquery?: Record<string, string>

    The query parameters to include in the URL.

    -
  • Optional Readonlysubdomain?: string

    If 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.

    -

Settings

Member Visibility
diff --git a/docs/reference/types/ValidationErrorInfo.html b/docs/reference/types/ValidationErrorInfo.html deleted file mode 100644 index 2420031..0000000 --- a/docs/reference/types/ValidationErrorInfo.html +++ /dev/null @@ -1 +0,0 @@ -ValidationErrorInfo | @fal-ai/client

Type Alias ValidationErrorInfo

ValidationErrorInfo: {
    loc: (string | number)[];
    msg: string;
    type: string;
}

Settings

Member Visibility
diff --git a/docs/reference/types/WebHookResponse.html b/docs/reference/types/WebHookResponse.html deleted file mode 100644 index d0bae15..0000000 --- a/docs/reference/types/WebHookResponse.html +++ /dev/null @@ -1,13 +0,0 @@ -WebHookResponse | @fal-ai/client

Type Alias WebHookResponse<Payload>

WebHookResponse<Payload>: {
    error: never;
    payload: Payload;
    request_id: string;
    status: "OK";
} | {
    error: string;
    payload: Payload;
    request_id: string;
    status: "ERROR";
}

Represents the response from a WebHook request. -This is a union type that varies based on the status property.

-

Type Parameters

  • Payload = any

    The type of the payload in the response. It defaults to any, -allowing for flexibility in specifying the structure of the payload.

    -

Type declaration

  • error: never

    Error is never present in a successful response.

    -
  • payload: Payload

    The payload of the response, structure determined by the Payload type.

    -
  • request_id: string

    The unique identifier for the request.

    -
  • status: "OK"

    Indicates a successful response.

    -

Type declaration

  • error: string

    Description of the error that occurred.

    -
  • payload: Payload

    The payload of the response, structure determined by the Payload type.

    -
  • request_id: string

    The unique identifier for the request.

    -
  • status: "ERROR"

    Indicates an unsuccessful response.

    -

Settings

Member Visibility
diff --git a/docs/reference/variables/fal.html b/docs/reference/variables/fal.html deleted file mode 100644 index 46e85a9..0000000 --- a/docs/reference/variables/fal.html +++ /dev/null @@ -1,3 +0,0 @@ -fal | @fal-ai/client

Variable falConst

fal: SingletonFalClient = ...

Creates 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.

-

Settings

Member Visibility