ecded55c2f
* feat(client): endpoint type definitions * fix(client): endpoint generation * fix(demo): streaming page type * chore: update reference docs * chore: prepare client release * chore: update reference docs
41 lines
37 KiB
HTML
Generated
41 lines
37 KiB
HTML
Generated
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FalClient | @fal-ai/client - v1.1.0</title><meta name="description" content="Documentation for @fal-ai/client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@fal-ai/client - v1.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@fal-ai/client</a></li><li><a href="FalClient.html">FalClient</a></li></ul><h1>Interface FalClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The main client type, it provides access to simple API model usage,
|
||
as well as access to the <code>queue</code> and <code>storage</code> APIs.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>createFalClient</p>
|
||
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FalClient</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="FalClient.html#queue">queue</a><span class="tsd-signature-symbol">: </span><a href="QueueClient.html" class="tsd-signature-type tsd-kind-interface">QueueClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="FalClient.html#realtime">realtime</a><span class="tsd-signature-symbol">: </span><a href="RealtimeClient.html" class="tsd-signature-type tsd-kind-interface">RealtimeClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="FalClient.html#storage">storage</a><span class="tsd-signature-symbol">: </span><a href="StorageClient.html" class="tsd-signature-type tsd-kind-interface">StorageClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="FalClient.html#stream">stream</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StreamOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../classes/FalStream.html" class="tsd-signature-type tsd-kind-class">FalStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="FalClient.html#streaming">streaming</a><span class="tsd-signature-symbol">: </span><a href="StreamingClient.html" class="tsd-signature-type tsd-kind-interface">StreamingClient</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="FalClient.html#run.run-1">run</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/RunOptions.html" class="tsd-signature-type tsd-kind-type-alias">RunOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="FalClient.html#subscribe.subscribe-1">subscribe</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/RunOptions.html" class="tsd-signature-type tsd-kind-type-alias">RunOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">QueueSubscribeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L17">client.ts:17</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FalClient.html#queue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>queue</span></a>
|
||
<a href="FalClient.html#realtime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>realtime</span></a>
|
||
<a href="FalClient.html#storage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>storage</span></a>
|
||
<a href="FalClient.html#stream" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stream</span></a>
|
||
<a href="FalClient.html#streaming" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="FalClient.html#run" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run</span></a>
|
||
<a href="FalClient.html#subscribe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="queue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>queue</span><a href="#queue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">queue</span><span class="tsd-signature-symbol">:</span> <a href="QueueClient.html" class="tsd-signature-type tsd-kind-interface">QueueClient</a></div><div class="tsd-comment tsd-typography"><p>The queue client to interact with the queue API.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L21">client.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="realtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>realtime</span><a href="#realtime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">realtime</span><span class="tsd-signature-symbol">:</span> <a href="RealtimeClient.html" class="tsd-signature-type tsd-kind-interface">RealtimeClient</a></div><div class="tsd-comment tsd-typography"><p>The realtime client to interact with the realtime API
|
||
and receive updates in real-time.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="See-1" class="tsd-anchor"></a>See<a href="#See-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
||
<li>#RealtimeClient</li>
|
||
<li>#RealtimeClient.connect</li>
|
||
</ul>
|
||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L29">client.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="storage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>storage</span><a href="#storage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">storage</span><span class="tsd-signature-symbol">:</span> <a href="StorageClient.html" class="tsd-signature-type tsd-kind-interface">StorageClient</a></div><div class="tsd-comment tsd-typography"><p>The storage client to interact with the storage API.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L34">client.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stream</span><a href="#stream" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stream</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">StreamOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../classes/FalStream.html" class="tsd-signature-type tsd-kind-class">FalStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>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
|
||
<code>AsyncIterator</code> or through an event listener.</p>
|
||
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="stream.__type.__type-1"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../classes/FalStream.html" class="tsd-signature-type tsd-kind-class">FalStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>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
|
||
<code>AsyncIterator</code> or through an event listener.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="stream.__type.__type-1.Id" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Id</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EndpointType</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpointId</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a></span><div class="tsd-comment tsd-typography"><p>the endpoint id, e.g. <code>fal-ai/llavav15-13b</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">StreamOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>the request options, including the input payload.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../classes/FalStream.html" class="tsd-signature-type tsd-kind-class">FalStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#stream.__type.__type-1.Id">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>the <code>FalStream</code> instance.</p>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: endpointId" class="tsd-anchor"></a>Param: endpointId<a href="#Param: endpointId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>the endpoint id, e.g. <code>fal-ai/llavav15-13b</code>.</p>
|
||
<h4 class="tsd-anchor-link"><a id="Param: options" class="tsd-anchor"></a>Param: options<a href="#Param: options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>the request options, including the input payload.</p>
|
||
<h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>the <code>FalStream</code> instance.</p>
|
||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L74">client.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="streaming" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>streaming</span><a href="#streaming" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">streaming</span><span class="tsd-signature-symbol">:</span> <a href="StreamingClient.html" class="tsd-signature-type tsd-kind-interface">StreamingClient</a></div><div class="tsd-comment tsd-typography"><p>The streaming client to interact with the streaming API.</p>
|
||
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="See-2" class="tsd-anchor"></a>See<a href="#See-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>#stream</p>
|
||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L40">client.ts:40</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="run" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="run.run-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#run.run-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Runs a fal endpoints identified by its <code>endpointId</code>.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="run.run-1.Id-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Id</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EndpointType</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpointId</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a></span><div class="tsd-comment tsd-typography"><p>the registered function revision id or alias.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/RunOptions.html" class="tsd-signature-type tsd-kind-type-alias">RunOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#run.run-1.Id-1">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>the remote function output</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L48">client.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subscribe.subscribe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribe</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpointId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#subscribe.subscribe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribes to updates for a specific request in the queue.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="subscribe.subscribe-1.Id-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Id</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">EndpointType</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpointId</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a></span><div class="tsd-comment tsd-typography"><p>The ID of the API endpoint.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/RunOptions.html" class="tsd-signature-type tsd-kind-type-alias">RunOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">QueueSubscribeOptions</span></span><div class="tsd-comment tsd-typography"><p>Options to configure how the request is run and how updates are received.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OutputType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="FalClient.html#subscribe.subscribe-1.Id-2">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves to the result of the request once it's completed.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/fal-ai/fal-js/blob/c2e44f775f6128c3b43337b6f614f4138fdef727/libs/client/src/client.ts#L60">client.ts:60</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#queue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>queue</span></a><a href="#realtime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>realtime</span></a><a href="#storage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>storage</span></a><a href="#stream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stream</span></a><a href="#streaming" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#run" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run</span></a><a href="#subscribe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@fal-ai/client - v1.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|