Skip to content

Commit f66ec66

Browse files
Deploying to gh-pages from @ 43363a7 🚀
1 parent c2b1c9a commit f66ec66

File tree

61 files changed

+737
-736
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+737
-736
lines changed

.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ dist/lato-latin-ext-300-normal-VPGGJKJL.woff2
365365
dist/lato-latin-ext-400-normal-N27NCBWW.woff2
366366
dist/lato-latin-ext-700-normal-Q2L5DVMW.woff2
367367
dist/remixicon-NKANDIL5.woff2
368-
dist/search_data-696E0927.js
368+
dist/search_data-FBEB2CAC.js
369369
dist/sidebar_items-609BD6D8.js
370370
index.html
371371
provisioning.html

Lightning.Accounts.html

Lines changed: 71 additions & 71 deletions
Large diffs are not rendered by default.

Lightning.AdaptorRegistry.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ <h1>
141141
<p>Registry process to query and maintain a list of adaptors available for
142142
writing jobs.</p><p>Currently it queries NPM for all modules in the <code class="inline">@openfn</code> organization and
143143
filters out modules that are known not to be adaptors.</p><p><strong>Usage</strong></p><pre><code class="makeup elixir" translate="no"><span class="c1"># Starting the process</span><span class="w">
144-
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="3826875627-1">(</span><span class="p" data-group-id="3826875627-1">)</span><span class="w">
144+
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="2793169394-1">(</span><span class="p" data-group-id="2793169394-1">)</span><span class="w">
145145
</span><span class="c1"># Getting a list of all adaptors</span><span class="w">
146-
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="3826875627-2">(</span><span class="p" data-group-id="3826875627-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
146+
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="2793169394-2">(</span><span class="p" data-group-id="2793169394-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
147147
This does mean that the first call to the process will be delayed until
148148
the <code class="inline">handle_continue/2</code> has finished.</p><p><strong>Timeouts</strong></p><p>There is a 'general' timeout of 30s, this is used for GenServer calls like
149149
<a href="#all/1"><code class="inline">all/1</code></a> and also internally when the modules are being queried. NPM can
@@ -464,10 +464,10 @@ <h1 class="signature" translate="no">resolve_package_name(package_name)</h1>
464464

465465
</div>
466466

467-
<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="7875242366-1">(</span><span class="s">&quot;@openfn/[email protected]&quot;</span><span class="p" data-group-id="7875242366-1">)</span><span class="w">
468-
</span><span class="p" data-group-id="7875242366-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="7875242366-2">}</span><span class="w">
469-
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="7875242366-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="7875242366-3">)</span><span class="w">
470-
</span><span class="p" data-group-id="7875242366-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="7875242366-4">}</span></code></pre>
467+
<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="0279772805-1">(</span><span class="s">&quot;@openfn/[email protected]&quot;</span><span class="p" data-group-id="0279772805-1">)</span><span class="w">
468+
</span><span class="p" data-group-id="0279772805-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="0279772805-2">}</span><span class="w">
469+
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="0279772805-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="0279772805-3">)</span><span class="w">
470+
</span><span class="p" data-group-id="0279772805-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="0279772805-4">}</span></code></pre>
471471
</section>
472472
</section>
473473
<section class="detail" id="resolve_package_name!/1">

Lightning.AiAssistant.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -509,8 +509,8 @@ <h1 class="signature" translate="no">query(session, content)</h1>
509509

510510
</div>
511511

512-
<p>Queries the AI assistant with the given content.</p><p>Returns <code class="inline">{:ok, session}</code> if the query was successful, otherwise <code class="inline">{:error, reason}</code>.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">AiAssistant</span><span class="o">.</span><span class="n">query</span><span class="p" data-group-id="5076883332-1">(</span><span class="n">session</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fn()&quot;</span><span class="p" data-group-id="5076883332-1">)</span><span class="w">
513-
</span><span class="p" data-group-id="5076883332-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">session</span><span class="p" data-group-id="5076883332-2">}</span></code></pre>
512+
<p>Queries the AI assistant with the given content.</p><p>Returns <code class="inline">{:ok, session}</code> if the query was successful, otherwise <code class="inline">{:error, reason}</code>.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">AiAssistant</span><span class="o">.</span><span class="n">query</span><span class="p" data-group-id="5782021185-1">(</span><span class="n">session</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fn()&quot;</span><span class="p" data-group-id="5782021185-1">)</span><span class="w">
513+
</span><span class="p" data-group-id="5782021185-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">session</span><span class="p" data-group-id="5782021185-2">}</span></code></pre>
514514
</section>
515515
</section>
516516
<section class="detail" id="save_message/4">

0 commit comments

Comments
 (0)