Skip to content

Commit

Permalink
v7.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@bhovhannes
bhovhannes committed May 7, 2020
1 parent 3cd201c commit 6facb40
Show file tree
Hide file tree
Showing 10 changed files with 275 additions and 123 deletions.
153 changes: 153 additions & 0 deletions CHANGELOG.md
View file

Large diffs are not rendered by default.

30 changes: 14 additions & 16 deletions docs/assets/js/main.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2107,16 +2107,14 @@ var typedoc,
_this.createGroups(),
_this.container &&
(_this.el.classList.add('active'),
_this.el
.querySelectorAll('.tsd-signature')
.forEach(function (signature) {
signature.addEventListener('touchstart', function (event) {
return _this.onClick(event)
}),
signature.addEventListener('click', function (event) {
return _this.onClick(event)
})
Array.from(_this.el.children).forEach(function (signature) {
signature.addEventListener('touchstart', function (event) {
return _this.onClick(event)
}),
signature.addEventListener('click', function (event) {
return _this.onClick(event)
})
}),
_this.container.classList.add('active'),
_this.setIndex(0)),
_this
Expand Down Expand Up @@ -2145,15 +2143,15 @@ var typedoc,
}
}),
(Signature.prototype.createGroups = function () {
var _this = this,
signatures = this.el.querySelectorAll('.tsd-signature')
var signatures = this.el.children
if (!(signatures.length < 2)) {
this.container = this.el.nextElementSibling
var descriptions = this.container.querySelectorAll('.tsd-description')
;(this.groups = []),
signatures.forEach(function (el, index) {
_this.groups.push(new SignatureGroup(el, descriptions[index]))
})
var descriptions = this.container.children
this.groups = []
for (var index = 0; index < signatures.length; index++)
this.groups.push(
new SignatureGroup(signatures[index], descriptions[index])
)
}
}),
(Signature.prototype.onClick = function (e) {
Expand Down
66 changes: 33 additions & 33 deletions docs/classes/_api_.api.html
View file

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions docs/classes/_node_.nodeapi.html
View file

Large diffs are not rendered by default.

15 changes: 8 additions & 7 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h1>workfront-api</h1>
<a href="#workfront-api" id="workfront-api" style="color: inherit; text-decoration: none;">
<h1>workfront-api</h1>
</a>
<p><a href="https://www.npmjs.org/package/workfront-api"><img src="https://img.shields.io/npm/v/workfront-api.svg?style=flat" alt="NPM version"></a> <a href="https://www.npmjs.org/package/workfront-api"><img src="https://img.shields.io/npm/dm/workfront-api.svg?style=flat" alt="NPM downloads"></a> <a href="LICENSE"><img src="http://img.shields.io/badge/license-APv2-blue.svg?style=flat" alt="Apache v2 License"></a> <a href="https://travis-ci.com/Workfront/workfront-api"><img src="https://img.shields.io/travis/Workfront/workfront-api.svg?style=flat" alt="Build Status"></a> <a href="https://codecov.io/gh/Workfront/workfront-api"><img src="https://codecov.io/gh/Workfront/workfront-api/branch/master/graph/badge.svg" alt="Coverage"></a> <a href="https://codeclimate.com/github/Workfront/workfront-api"><img src="https://img.shields.io/codeclimate/github/Workfront/workfront-api.svg?style=flat" alt="Code Climate"></a>
<p><a href="https://www.npmjs.org/package/workfront-api"><img src="https://img.shields.io/npm/v/workfront-api.svg?style=flat-square" alt="NPM version"></a> <a href="https://www.npmjs.org/package/workfront-api"><img src="https://img.shields.io/npm/dm/workfront-api.svg?style=flat-square" alt="NPM downloads"></a> <a href="LICENSE"><img src="http://img.shields.io/badge/license-APv2-blue.svg?style=flat-square" alt="Apache v2 License"></a> <a href="https://travis-ci.com/Workfront/workfront-api"><img src="https://img.shields.io/travis/Workfront/workfront-api.svg?style=flat-square" alt="Build Status"></a> <a href="https://codecov.io/gh/Workfront/workfront-api"><img src="https://codecov.io/gh/Workfront/workfront-api/branch/master/graph/badge.svg" alt="Coverage"></a> <a href="https://codeclimate.com/github/Workfront/workfront-api"><img src="https://img.shields.io/codeclimate/maintainability/Workfront/workfront-api?style=flat-square" alt="Code Climate"></a>
<a href="https://saucelabs.com/beta/builds/1b8be6f71455499c82f02afc881e6c14"><img src="https://saucelabs.com/buildstatus/citizensas" alt="Build Status"></a></p>
<p><a href="https://saucelabs.com/beta/builds/1b8be6f71455499c82f02afc881e6c14"><img src="https://saucelabs.com/browser-matrix/citizensas.svg" alt="Build Status"></a></p>
<p>A client for Workfront API which can be used in both server (NodeJS) and client (browsers).</p>
Expand Down Expand Up @@ -96,19 +96,20 @@ <h2>Documentation</h2>
<h2>Examples</h2>
</a>
<p>A number of examples can be found under <a href="examples">examples</a> directory. It includes examples for both <a href="examples/node">node</a> and <a href="examples/browser">browser</a> environments.<br>In order to run these examples clone a copy of workfront-api repository:</p>
<pre><code>git <span class="hljs-keyword">clone</span> <span class="hljs-title">git</span>://github.com/Workfront/workfront-api.git</code></pre>
<pre><code class="language-shell">git clone git://github.com/Workfront/workfront-api.git</code></pre>
<a href="#running-node-examples" id="running-node-examples" style="color: inherit; text-decoration: none;">
<h4>Running <a href="examples/node">node</a> examples</h4>
</a>
<p>First enter into <code>workfront-api</code> directory and install all the dependencies:</p>
<pre><code><span class="hljs-attr">cd</span> <span class="hljs-string">workfront-api</span>
<span class="hljs-attr">npm</span> <span class="hljs-string">install</span></code></pre><p>Use <code>node</code> to run the examples. For examples:</p>
<pre><code><span class="hljs-built_in">cd</span> workfront-api
yarn</code></pre><p>Use <code>node</code> to run the examples. For examples:</p>
<pre><code><span class="hljs-keyword">node</span> <span class="hljs-title">examples</span>/<span class="hljs-keyword">node</span><span class="hljs-title">/get-user-count</span>.js</code></pre><p>Each example script outputs all its results into console and contains comments in the source code explaining what is happening in more details.</p>
<a href="#running-browser-examples" id="running-browser-examples" style="color: inherit; text-decoration: none;">
<h4>Running <a href="examples/browser">browser</a> examples</h4>
</a>
<p>To start supplied webserver type:</p>
<pre><code><span class="hljs-built_in">npm</span> start</code></pre><p>Visit <a href="http://localhost:8000/examples/browser/">http://localhost:8000/examples/browser/</a> to see list of all examples available for browser.</p>
<pre><code class="language-shell">npm start</code></pre>
<p>Visit <a href="http://localhost:8000/examples/browser/">http://localhost:8000/examples/browser/</a> to see list of all examples available for browser.</p>
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
<h2>Contributing</h2>
</a>
Expand All @@ -120,8 +121,8 @@ <h3>Bug Reports</h3>
<ol>
<li><strong>Use the GitHub issue search</strong> &mdash; check if the issue has already been
reported.</li>
<li><strong>Isolate the problem</strong> &mdash; ideally create a <a href="https://css-tricks.com/reduced-test-cases/">reduced test
case</a>.</li>
<li><strong>Isolate the problem</strong> &mdash; ideally create a [reduced test
case](<a href="https://css-tricks.com/reduced-test-cases/">https://css-tricks.com/reduced-test-cases/</a>).</li>
<li>A good bug report shouldn&#39;t leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.</li>
</ol>
<a href="#feature-requests" id="feature-requests" style="color: inherit; text-decoration: none;">
Expand Down
10 changes: 5 additions & 5 deletions docs/interfaces/_api_.iapiconfig.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Use<wbr>Ge
<div class="tsd-signature tsd-kind-icon">always<wbr>Use<wbr>Get<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/478e928/src/Api.ts#L38">Api.ts:38</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/3cd201c/src/Api.ts#L38">Api.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">api<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/478e928/src/Api.ts#L39">Api.ts:39</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/3cd201c/src/Api.ts#L39">Api.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -120,7 +120,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/478e928/src/Api.ts#L40">Api.ts:40</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/3cd201c/src/Api.ts#L40">Api.ts:40</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -138,7 +138,7 @@ <h3>url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/478e928/src/Api.ts#L36">Api.ts:36</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/3cd201c/src/Api.ts#L36">Api.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/478e928/src/Api.ts#L37">Api.ts:37</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/3cd201c/src/Api.ts#L37">Api.ts:37</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 6facb40

Please sign in to comment.