Skip to content

Commit 9ee7d7b

Browse files
TopenerTopener
committed
add promise support
1 parent ea3b229 commit 9ee7d7b

File tree

4 files changed

+164
-128
lines changed

4 files changed

+164
-128
lines changed

‎README.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
11
# ti.xhr:
22
ti.xhr is a wrapper around Titanium's HTTPClient. It works perfectly with REST API endpoints and has a built in cache system that you can use for your requests. But it also can be use for any HTTP requests, you can even cache remote images.
3-
4-
5-
> Version 3.0.0 is incompatible with any previous version. Only slight refactor is needed to make the method arguments a single object instead.
6-
7-
83
## Installation.
94
Use NPM to install ti.xhr.
105

11-
Run this command in your `lib` folder (Alloy) or `Resources` folder (classic).
6+
Run this command in your `lib` folder (Alloy) or `Resources` folder (classic) or in the root directory of your app when using Webpack.
127
```
138
npm i ti.xhr
149
```
15-
16-
Or install it by download the latest release from the `dist` folder and unpackage it in your root directory.
17-
1810
## Usage:
1911
In your alloy.js (or elsewhere), call:
2012

@@ -72,6 +64,7 @@ If you do specify options in an API call, it will not ignore global options. Thi
7264
* `returnXML` (default `false`) - Do you expect XML returned, put this to `true`
7365
* `debug` (default `false`) - Do you want `Ti.API.info` to show API calls made
7466
* `requestHeaders` (default `[]`) - Add custom request headers to the request
67+
* `promise` (default `false`) - Returns a Promise when `true`
7568

7669
For some examples please check out the [examples.js](https://github.com/topener/XHR/blob/master/examples.js) file. Or browse around the [ti.xhr.js](https://github.com/topener/XHR/blob/master/ti.xhr.js) file. You can find in there support for GET, POST, PUT, PATCH and DELETE
7770

@@ -95,6 +88,25 @@ This will set the requestHeader like you would do previously:
9588
xhr.setRequestHeader('myCustomId', 'myCustomValue');
9689
```
9790

91+
## Promises
92+
If you want to use promises you can set the `promise` property, best would be to use the `setStaticOptions` method for that so you never have to configure it again.
93+
94+
```javascript
95+
xhr.setStaticOptions({
96+
promise: true
97+
});
98+
```
99+
Then every call returns a promise, which you can handle using `await` or `then` as with all promises.
100+
101+
```javascript
102+
await result = xhr.GET({});
103+
104+
xhr.GET({}).then(result => {
105+
106+
});
107+
```
108+
Promises work with all supported methods. Don't forget to add error handling.
109+
98110
## Helpers
99111
Apart from the RESTful way of interacting with your API endpoints, this module also includes the following helper methods:
100112

‎manifest

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 3.0.2
1+
version: 3.1.0
22
description: Super awesome HTTP Client for Appcelerator Titanium
33
author: Rene Pot
44
license: Apache 2.0
@@ -7,4 +7,4 @@ name: ti.xhr
77
moduleid: ti.xhr
88
guid: 451f87e4-b287-4561-a362-92cce74d72c9
99
platform: commonjs
10-
minsdk: 6.0.0.GA
10+
minsdk: 9.0.0.GA

‎package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "ti.xhr",
33
"description": "Super awesome HTTP Client for Appcelerator Titanium",
4-
"version": "3.0.2",
4+
"version": "3.1.0",
55
"license": "MIT",
66
"main": "ti.xhr.js",
77
"keywords": ["xhr","http","titanium","titanium-module"],
8-
"author": "Rene Pot & Raul Riera",
8+
"author": "Rene Pot",
99
"repository": {
1010
"type": "git",
1111
"url": "git+https://github.com/Topener/XHR.git"

‎ti.xhr.js

+139-115
Original file line numberDiff line numberDiff line change
@@ -10,170 +10,193 @@ XHR = function() {};
1010
// GET
1111
// @e (object) url is required field. supports onSucces, onError and extraParams.
1212
XHR.prototype.GET = function(e) {
13-
// Create some default params
14-
var onSuccess = e.onSuccess || function() {};
15-
var onError = e.onError || function() {};
16-
17-
if (e.extraParams) {
18-
var extraParams = addDefaultsToOptions(e.extraParams);
19-
} else {
20-
var extraParams = storedExtraParams;
21-
}
13+
return new Promise((resolve, reject) => {
14+
// Create some default params
15+
let onSuccess = e.onSuccess || function() {};
16+
let onError = e.onError || function() {};
17+
if (e.extraParams) {
18+
var extraParams = addDefaultsToOptions(e.extraParams);
19+
} else {
20+
var extraParams = storedExtraParams;
21+
}
2222

23-
var cache = readCache(e.url);
23+
var cache = readCache(e.url);
2424

25-
// If there is nothing cached, send the request
26-
if (cache === false || !extraParams.ttl) {
25+
// If there is nothing cached, send the request
26+
if (cache === false || !extraParams.ttl) {
2727

28-
var xhr = initXHRRequest('GET', e.url, extraParams);
28+
var xhr = initXHRRequest('GET', e.url, extraParams);
2929

30-
// When the connection was successful
31-
xhr.onload = function() {
32-
var result = handleSuccess(xhr, extraParams);
33-
onSuccess(result);
30+
// When the connection was successful
31+
xhr.onload = function() {
32+
var result = handleSuccess(xhr, extraParams);
33+
onSuccess(result);
3434

35-
// only cache if there is a ttl
36-
if (extraParams.ttl) {
37-
writeCache(result.data, e.url, extraParams.ttl);
38-
}
39-
};
35+
// only cache if there is a ttl
36+
if (extraParams.ttl) {
37+
writeCache(result.data, e.url, extraParams.ttl);
38+
}
39+
if (extraParams.promise) resolve(result);
40+
};
4041

41-
// When there was an error
42-
xhr.onerror = function(err) {
43-
onError(handleError(xhr, err));
44-
};
42+
// When there was an error
43+
xhr.onerror = function(err) {
44+
let error = handleError(xhr, err);
45+
onError(error);
46+
if (extraParams.promise) reject(error);
47+
};
4548

46-
xhr.send();
49+
xhr.send();
4750

48-
} else {
51+
} else {
4952

50-
var result = {};
51-
result.result = "cache";
52-
result.status = 304;
53-
// not modified
54-
result.data = cache;
53+
var result = {};
54+
result.result = "cache";
55+
result.status = 304;
56+
// not modified
57+
result.data = cache;
5558

56-
onSuccess(result);
57-
}
59+
onSuccess(result);
60+
if (extraParams.promise) resolve(result);
61+
}
62+
63+
});
5864
};
5965

6066
// POST requests
6167
// @e (object) url & data are required, supports onSuccess, onError and extraParams
6268
XHR.prototype.POST = function(e) {
69+
return new Promise((resolve, reject) => {
70+
// Create some default params
71+
var onSuccess = e.onSuccess || function() {};
72+
var onError = e.onError || function() {};
6373

64-
// Create some default params
65-
var onSuccess = e.onSuccess || function() {};
66-
var onError = e.onError || function() {};
67-
68-
if (e.extraParams) {
69-
var extraParams = addDefaultsToOptions(e.extraParams);
70-
} else {
71-
var extraParams = storedExtraParams;
72-
}
74+
if (e.extraParams) {
75+
var extraParams = addDefaultsToOptions(e.extraParams);
76+
} else {
77+
var extraParams = storedExtraParams;
78+
}
7379

74-
var xhr = initXHRRequest('POST', e.url, extraParams);
80+
var xhr = initXHRRequest('POST', e.url, extraParams);
7581

76-
// When the connection was successful
77-
xhr.onload = function() {
78-
onSuccess(handleSuccess(xhr, extraParams));
79-
};
82+
// When the connection was successful
83+
xhr.onload = function() {
84+
let result = handleSuccess(xhr, extraParams)
85+
onSuccess(result);
86+
if (extraParams.promise) resolve(result);
87+
};
8088

81-
// When there was an error
82-
xhr.onerror = function(err) {
83-
// Check the status of this
84-
onError(handleError(xhr, err));
85-
};
89+
// When there was an error
90+
xhr.onerror = function(err) {
91+
let error = handleError(xhr, error);
92+
onError(error);
93+
if (extraParams.promise) reject(error);
94+
};
8695

87-
xhr.send(extraParams.parseJSON ? JSON.stringify(e.data) : e.data);
96+
xhr.send(extraParams.parseJSON ? JSON.stringify(e.data) : e.data);
97+
});
8898
};
8999

90100
// PUT requests
91101
// @e (object) url & data are required, supports onSuccess, onError and extraParams
92102
XHR.prototype.PUT = function(e) {
103+
return new Promise((resolve, reject) => {
104+
// Create some default params
105+
var onSuccess = e.onSuccess || function() {};
106+
var onError = e.onError || function() {};
93107

94-
// Create some default params
95-
var onSuccess = e.onSuccess || function() {};
96-
var onError = e.onError || function() {};
97-
98-
if (e.extraParams) {
99-
var extraParams = addDefaultsToOptions(e.extraParams);
100-
} else {
101-
var extraParams = storedExtraParams;
102-
}
108+
if (e.extraParams) {
109+
var extraParams = addDefaultsToOptions(e.extraParams);
110+
} else {
111+
var extraParams = storedExtraParams;
112+
}
103113

104-
var xhr = initXHRRequest('PUT', e.url, extraParams);
114+
var xhr = initXHRRequest('PUT', e.url, extraParams);
105115

106-
// When the connection was successful
107-
xhr.onload = function() {
108-
onSuccess(handleSuccess(xhr, extraParams));
109-
};
116+
// When the connection was successful
117+
xhr.onload = function() {
118+
let result = handleSuccess(xhr, extraParams);
119+
onSuccess(result);
120+
if (extraParams.promise) resolve(result);
121+
};
110122

111-
// When there was an error
112-
xhr.onerror = function(err) {
113-
// Check the status of this
114-
onError(handleError(xhr, err));
115-
};
123+
// When there was an error
124+
xhr.onerror = function(err) {
125+
// Check the status of this
126+
let error = handleError(xhr, err)
127+
onError(error);
128+
if (extraParams.promise) reject(error);
129+
};
116130

117-
xhr.send(extraParams.parseJSON ? JSON.stringify(e.data) : e.data);
131+
xhr.send(extraParams.parseJSON ? JSON.stringify(e.data) : e.data);
132+
});
118133
};
119134

120135
// PATCH requests
121136
// @e (object) url & data are required, supports onSuccess, onError and extraParams
122137
XHR.prototype.PATCH = function(e) {
138+
return new Promise((resolve, reject) => {
139+
// Create some default params
140+
var onSuccess = e.onSuccess || function() {};
141+
var onError = e.onError || function() {};
123142

124-
// Create some default params
125-
var onSuccess = e.onSuccess || function() {};
126-
var onError = e.onError || function() {};
127-
128-
if (e.extraParams) {
129-
var extraParams = addDefaultsToOptions(e.extraParams);
130-
} else {
131-
var extraParams = storedExtraParams;
132-
}
143+
if (e.extraParams) {
144+
var extraParams = addDefaultsToOptions(e.extraParams);
145+
} else {
146+
var extraParams = storedExtraParams;
147+
}
133148

134-
var xhr = initXHRRequest('PATCH', e.url, extraParams);
149+
var xhr = initXHRRequest('PATCH', e.url, extraParams);
135150

136-
// When the connection was successful
137-
xhr.onload = function() {
138-
onSuccess(handleSuccess(xhr, extraParams));
139-
};
151+
// When the connection was successful
152+
xhr.onload = function() {
153+
let result = handleSuccess(xhr, extraParams);
154+
onSuccess(result);
155+
if (extraParams.promise) resolve(result);
156+
};
140157

141-
// When there was an error
142-
xhr.onerror = function(err) {
143-
// Check the status of this
144-
onError(handleError(xhr, err));
145-
};
158+
// When there was an error
159+
xhr.onerror = function(err) {
160+
let error = handleError(xhr, err);
161+
onError(error);
162+
if (extraParams.promise) reject(error);
163+
};
146164

147-
xhr.send(extraParams.parseJSON ? JSON.stringify(e.data) : e.data);
165+
xhr.send(extraParams.parseJSON ? JSON.stringify(e.data) : e.data);
166+
});
148167
};
149168

150169
// @e (object) url is required, supports onSuccess, onError and extraParams
151170
XHR.prototype.DELETE = function(e) {
171+
return new Promise((resolve, reject) => {
172+
// Create some default params
173+
var onSuccess = e.onSuccess || function() {};
174+
var onError = e.onError || function() {};
152175

153-
// Create some default params
154-
var onSuccess = e.onSuccess || function() {};
155-
var onError = e.onError || function() {};
156-
157-
if (extraParams) {
158-
var extraParams = addDefaultsToOptions(extraParams);
159-
} else {
160-
var extraParams = storedExtraParams;
161-
}
176+
if (extraParams) {
177+
var extraParams = addDefaultsToOptions(extraParams);
178+
} else {
179+
var extraParams = storedExtraParams;
180+
}
162181

163-
var xhr = initXHRRequest('DELETE', e.url, extraParams);
182+
var xhr = initXHRRequest('DELETE', e.url, extraParams);
164183

165-
// When the connection was successful
166-
xhr.onload = function() {
167-
onSuccess(handleSuccess(xhr, extraParams));
168-
};
184+
// When the connection was successful
185+
xhr.onload = function() {
186+
let result = handleSuccess(xhr, extraParams);
187+
onSuccess(result);
188+
if (extraParams.promise) resolve(result);
189+
};
169190

170-
// When there was an error
171-
xhr.onerror = function(err) {
172-
// Check the status of this
173-
onError(handleError(xhr, err));
174-
};
191+
// When there was an error
192+
xhr.onerror = function(err) {
193+
let error = handleError(xhr, err);
194+
onError(error);
195+
if (extraParams.promise) reject(error);
196+
};
175197

176-
xhr.send();
198+
xhr.send();
199+
});
177200
};
178201

179202
// Helper functions
@@ -275,6 +298,7 @@ function addDefaultsToOptions(providedParams) {
275298
extraParams.returnXML = (extraParams.hasOwnProperty('returnXML')) ? extraParams.returnXML : false;
276299
extraParams.debug = (extraParams.hasOwnProperty('debug')) ? extraParams.debug : false;
277300
extraParams.requestHeaders = providedParams.requestHeaders || [];
301+
extraParams.promise = providedParams.promise || false;
278302
return extraParams;
279303
}
280304

0 commit comments

Comments
 (0)