Skip to content

Commit

Permalink
release version 0.17.11
Browse files Browse the repository at this point in the history
  • Loading branch information
@simon-scherzinger
simon-scherzinger committed Nov 15, 2018
1 parent 583b416 commit bf5d853
Show file tree
Hide file tree
Showing 3 changed files with 187 additions and 4 deletions.
187 changes: 185 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset='utf-8' />
<title>ec.sdk 0.17.10 | Documentation</title>
<title>ec.sdk 0.17.11 | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
<link href='assets/style.css' type='text/css' rel='stylesheet' />
Expand All @@ -15,7 +15,7 @@
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>ec.sdk</h3>
<div class='mb1'><code>0.17.10</code></div>
<div class='mb1'><code>0.17.11</code></div>
<input
placeholder='Filter'
id='filter-input'
Expand Down Expand Up @@ -713,6 +713,18 @@ <h3 class='mb0 no-anchor'>ec.sdk</h3>
#signup
</a></li>

<li><a
href='#publicapitag'
class='regular pre-open'>
#tag
</a></li>

<li><a
href='#publicapitaglist'
class='regular pre-open'>
#tagList
</a></li>

<li><a
href='#publicapiconfigurablesignup'
class='regular pre-open'>
Expand Down Expand Up @@ -10938,6 +10950,177 @@ <h3 class='fl m0' id='publicapi'>



</section>

</div>
</div>

<div class='border-bottom' id='publicapitag'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>tag(tag)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>



<p>Load a single <a href="#publictagresource">PublicTagResource</a>.</p>



<div class='pre p1 fill-light mt0'>tag(tag: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="#publictagresource">PublicTagResource</a>></div>












<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>

<div class='space-bottom0'>
<div>
<span class='code bold'>tag</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
the tag

</div>

</div>

</div>






<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="#publictagresource">PublicTagResource</a>></code>:
Promise resolving to PublicTagResource








<div class='py1 quiet mt1 prose-big'>Example</div>


<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">return</span> assetList.tag(<span class="hljs-string">'thisOne'</span>)
.then(<span class="hljs-function"><span class="hljs-params">tag</span> =&gt;</span> {
<span class="hljs-keyword">return</span> show(tag);
});</pre>








</section>

</div>
</div>

<div class='border-bottom' id='publicapitaglist'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>tagList(options)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>



<p>Load the <a href="#publictaglist">PublicTagList</a>.</p>



<div class='pre p1 fill-light mt0'>tagList(options: <a href="#filteroptions">filterOptions</a>?): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="#publictaglist">PublicTagList</a>></div>












<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>

<div class='space-bottom0'>
<div>
<span class='code bold'>options</span> <code class='quiet'>(<a href="#filteroptions">filterOptions</a>?)</code>
filter options

</div>

</div>

</div>






<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="#publictaglist">PublicTagList</a>></code>:
Promise resolving to PublicTagList








<div class='py1 quiet mt1 prose-big'>Example</div>


<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">return</span> assetList.tagList()
.then(<span class="hljs-function"><span class="hljs-params">tags</span> =&gt;</span> {
<span class="hljs-keyword">return</span> tags.getAllItems().filter(<span class="hljs-function"><span class="hljs-params">tags</span> =&gt;</span> tag.tag === <span class="hljs-string">'thisOne'</span>);
})
.then(<span class="hljs-function"><span class="hljs-params">tagsArray</span> =&gt;</span> {
<span class="hljs-keyword">return</span> show(tagsArray[<span class="hljs-number">0</span>]);
});

<span class="hljs-comment">// This would actually be better:</span>
<span class="hljs-keyword">return</span> dm.tagList({
<span class="hljs-attr">filter</span>: {
<span class="hljs-attr">assetID</span>: <span class="hljs-string">'thisOne'</span>,
},
})
.then(<span class="hljs-function"><span class="hljs-params">tags</span> =&gt;</span> {
<span class="hljs-keyword">return</span> show(tags.getFirstItem());
});</pre>








</section>

</div>
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ec.sdk",
"version": "0.17.10",
"version": "0.17.11",
"description": "SDK for ec.api",
"repository": "entrecode/ec.sdk",
"author": "Simon Scherzinger <scherzinger@entrecode.de>",
Expand Down

0 comments on commit bf5d853

Please sign in to comment.