Skip to content

Commit d6db3d0

Browse files
PanayotCankovPanayotCankov
committed
Prepare for public v0.0.1
1 parent 7a69bee commit d6db3d0

8 files changed

+149
-104
lines changed

‎assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎globals.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>session</h3>
9797
<li class="tsd-description">
9898
<aside class="tsd-sources">
9999
<ul>
100-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L8">background-http.d.ts:8</a></li>
100+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L9">background-http.d.ts:9</a></li>
101101
</ul>
102102
</aside>
103103
<div class="tsd-comment tsd-typography">
@@ -109,6 +109,9 @@ <h4 class="tsd-parameters-title">Parameters</h4>
109109
<ul class="tsd-parameters">
110110
<li>
111111
<h5>id: <span class="tsd-signature-type">string</span></h5>
112+
<div class="tsd-comment tsd-typography">
113+
<p>The session id.</p>
114+
</div>
112115
</li>
113116
</ul>
114117
<h4 class="tsd-returns-title">Returns <a href="interfaces/_background_http_.session.html" class="tsd-signature-type">Session</a></h4>

‎index.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,17 @@ <h1> Background HTTP for NativeScript</h1>
6666
<li>iOS</li>
6767
<li>Android</li>
6868
</ul>
69-
<h3 id="how-to-background-upload">How-to Background Upload</h3>
69+
<h3 id="source">Source</h3>
70+
<ul>
71+
<li><a href="http://github.com/NativeScript/nativescript-background-http">GitHub</a></li>
72+
<li><a href="http://nativescript.github.io/nativescript-background-http/">Web Site</a></li>
73+
<li><a href="http://nativescript.github.io/nativescript-background-http/globals.html">API Reference</a></li>
74+
</ul>
75+
<h3 id="license">License</h3>
76+
<p><a href="https://github.com/NativeScript/nativescript-background-http/blob/master/LICENSE">Apache-2.0</a></p>
77+
<h3 id="how-to-background-upload">How-To Background Upload</h3>
7078
<pre><code class="lang-JavaScript"><span class="hljs-keyword">var</span> background_http = <span class="hljs-built_in">require</span>(<span class="hljs-string">"background-http"</span>);
79+
7180
<span class="hljs-keyword">var</span> session = background_http.session(<span class="hljs-string">"image-upload"</span>);
7281

7382
<span class="hljs-keyword">var</span> request = {
@@ -89,6 +98,25 @@ <h3 id="how-to-background-upload">How-to Background Upload</h3>
8998
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">onEvent</span>(<span class="hljs-params">e</span>) </span>{
9099
<span class="hljs-built_in">console</span>.log(e.eventName);
91100
}
101+
</code></pre>
102+
<h3 id="how-to-data-binding">How-To Data Binding</h3>
103+
<p>Task implementations are Observable and fire property change events for </p>
104+
<ul>
105+
<li>upload</li>
106+
<li>totalUpload</li>
107+
<li>status</li>
108+
</ul>
109+
<p>So you can bind to task properties in the UI markup:</p>
110+
<pre><code class="lang-XML"><span class="hljs-tag">&lt;<span class="hljs-title">ListView</span> <span class="hljs-attribute">items</span>=<span class="hljs-value">"{{ tasks }}"</span>&gt;</span>
111+
<span class="hljs-tag">&lt;<span class="hljs-title">ListView.itemTemplate</span>&gt;</span>
112+
<span class="hljs-tag">&lt;<span class="hljs-title">StackLayout</span>&gt;</span>
113+
<span class="hljs-tag">&lt;<span class="hljs-title">Label</span> <span class="hljs-attribute">text</span>=<span class="hljs-value">"{{ upload, 'Upload: ' + upload + ' / ' + totalUpload }}"</span> /&gt;</span>
114+
<span class="hljs-tag">&lt;<span class="hljs-title">Progress</span> <span class="hljs-attribute">value</span>=<span class="hljs-value">"{{ upload }}"</span> <span class="hljs-attribute">maxValue</span>=<span class="hljs-value">"{{ totalUpload }}"</span> /&gt;</span>
115+
<span class="hljs-tag">&lt;<span class="hljs-title">Label</span> <span class="hljs-attribute">text</span>=<span class="hljs-value">"{{ description, 'description: ' + description }}"</span> /&gt;</span>
116+
<span class="hljs-tag">&lt;<span class="hljs-title">Label</span> <span class="hljs-attribute">text</span>=<span class="hljs-value">"{{ status, 'status: ' + status }}"</span> /&gt;</span>
117+
<span class="hljs-tag">&lt;/<span class="hljs-title">StackLayout</span>&gt;</span>
118+
<span class="hljs-tag">&lt;/<span class="hljs-title">ListView.itemTemplate</span>&gt;</span>
119+
<span class="hljs-tag">&lt;/<span class="hljs-title">ListView</span>&gt;</span>
92120
</code></pre>
93121
</div>
94122
</div>

‎interfaces/_background_http_.erroreventdata.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ <h3>error</h3>
108108
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
109109
<aside class="tsd-sources">
110110
<ul>
111-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L17">background-http.d.ts:17</a></li>
111+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L18">background-http.d.ts:18</a></li>
112112
</ul>
113113
</aside>
114114
<div class="tsd-comment tsd-typography">

‎interfaces/_background_http_.progresseventdata.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h3>current<wbr>Bytes</h3>
109109
<div class="tsd-signature tsd-kind-icon">current<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L27">background-http.d.ts:27</a></li>
112+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L28">background-http.d.ts:28</a></li>
113113
</ul>
114114
</aside>
115115
<div class="tsd-comment tsd-typography">
@@ -156,7 +156,7 @@ <h3>total<wbr>Bytes</h3>
156156
<div class="tsd-signature tsd-kind-icon">total<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
157157
<aside class="tsd-sources">
158158
<ul>
159-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L32">background-http.d.ts:32</a></li>
159+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L33">background-http.d.ts:33</a></li>
160160
</ul>
161161
</aside>
162162
<div class="tsd-comment tsd-typography">

‎interfaces/_background_http_.request.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ <h3>description</h3>
104104
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
105105
<aside class="tsd-sources">
106106
<ul>
107-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L125">background-http.d.ts:125</a></li>
107+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L128">background-http.d.ts:128</a></li>
108108
</ul>
109109
</aside>
110110
<div class="tsd-comment tsd-typography">
111111
<div class="lead">
112112
<p>Use this to help you identify the task.
113-
Sets the HttpTask&#39;s description property.
114-
You can as well store serialized JSON object.</p>
113+
Sets the task&#39;s description property.
114+
You can store serialized JSON object.</p>
115115
</div>
116116
</div>
117117
</section>
@@ -121,7 +121,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
121121
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L118">background-http.d.ts:118</a></li>
124+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L121">background-http.d.ts:121</a></li>
125125
</ul>
126126
</aside>
127127
<div class="tsd-comment tsd-typography">
@@ -141,7 +141,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
141141
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
142142
<aside class="tsd-sources">
143143
<ul>
144-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L113">background-http.d.ts:113</a></li>
144+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L116">background-http.d.ts:116</a></li>
145145
</ul>
146146
</aside>
147147
<div class="tsd-comment tsd-typography">
@@ -157,7 +157,7 @@ <h3>url</h3>
157157
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
158158
<aside class="tsd-sources">
159159
<ul>
160-
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L107">background-http.d.ts:107</a></li>
160+
<li>Defined in <a href="https://github.com/NativeScript/nativescript-background-http/blob/master/source/background-http.d.ts#L110">background-http.d.ts:110</a></li>
161161
</ul>
162162
</aside>
163163
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)