-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ e1e08c7 🚀
- Loading branch information
Showing
54 changed files
with
655 additions
and
654 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -140,9 +140,9 @@ <h1> | |
| <p>Registry process to query and maintain a list of adaptors available for | ||
| writing jobs.</p><p>Currently it queries NPM for all modules in the <code class="inline">@openfn</code> organization and | ||
| 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"> | ||
| </span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="3041674735-1">(</span><span class="p" data-group-id="3041674735-1">)</span><span class="w"> | ||
| </span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="6938344725-1">(</span><span class="p" data-group-id="6938344725-1">)</span><span class="w"> | ||
| </span><span class="c1"># Getting a list of all adaptors</span><span class="w"> | ||
| </span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="3041674735-2">(</span><span class="p" data-group-id="3041674735-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. | ||
| </span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="6938344725-2">(</span><span class="p" data-group-id="6938344725-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. | ||
| This does mean that the first call to the process will be delayed until | ||
| 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 | ||
| <a href="#all/1"><code class="inline">all/1</code></a> and also internally when the modules are being queried. NPM can | ||
|
|
@@ -432,10 +432,10 @@ <h1 class="signature" translate="no">resolve_package_name(package_name)</h1> | |
|
|
||
| </div> | ||
|
|
||
| <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> </span><span class="n">resolve_package_name</span><span class="p" data-group-id="1797929989-1">(</span><span class="s">"@openfn/[email protected]"</span><span class="p" data-group-id="1797929989-1">)</span><span class="w"> | ||
| </span><span class="p" data-group-id="1797929989-2">{</span><span class="w"> </span><span class="s">"@openfn/language-salesforce"</span><span class="p">,</span><span class="w"> </span><span class="s">"1.2.3"</span><span class="w"> </span><span class="p" data-group-id="1797929989-2">}</span><span class="w"> | ||
| </span><span class="gp unselectable">iex> </span><span class="n">resolve_package_name</span><span class="p" data-group-id="1797929989-3">(</span><span class="s">"@openfn/language-salesforce"</span><span class="p" data-group-id="1797929989-3">)</span><span class="w"> | ||
| </span><span class="p" data-group-id="1797929989-4">{</span><span class="w"> </span><span class="s">"@openfn/language-salesforce"</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="1797929989-4">}</span></code></pre> | ||
| <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> </span><span class="n">resolve_package_name</span><span class="p" data-group-id="1312077409-1">(</span><span class="s">"@openfn/[email protected]"</span><span class="p" data-group-id="1312077409-1">)</span><span class="w"> | ||
| </span><span class="p" data-group-id="1312077409-2">{</span><span class="w"> </span><span class="s">"@openfn/language-salesforce"</span><span class="p">,</span><span class="w"> </span><span class="s">"1.2.3"</span><span class="w"> </span><span class="p" data-group-id="1312077409-2">}</span><span class="w"> | ||
| </span><span class="gp unselectable">iex> </span><span class="n">resolve_package_name</span><span class="p" data-group-id="1312077409-3">(</span><span class="s">"@openfn/language-salesforce"</span><span class="p" data-group-id="1312077409-3">)</span><span class="w"> | ||
| </span><span class="p" data-group-id="1312077409-4">{</span><span class="w"> </span><span class="s">"@openfn/language-salesforce"</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="1312077409-4">}</span></code></pre> | ||
| </section> | ||
| </section> | ||
| <section class="detail" id="resolve_package_name!/1"> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.