aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/0xjs/0.0.1/async.md
diff options
context:
space:
mode:
authorJacob Evans <jacob@dekz.net>2018-09-13 19:51:09 +0800
committerJacob Evans <jacob@dekz.net>2018-09-13 19:58:05 +0800
commitcf46d2c7049461e25441239e71f486bfbd2a986a (patch)
treeebed0751305adb60c74ec6691e360b331f1a26f1 /packages/website/md/docs/0xjs/0.0.1/async.md
parentdf5779b6d1a81f85b91c57fd2948ded91c1a07d7 (diff)
downloaddexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.gz
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.bz2
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.lz
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.xz
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.tar.zst
dexon-sol-tools-cf46d2c7049461e25441239e71f486bfbd2a986a.zip
0xjs README/website docs update
Diffstat (limited to 'packages/website/md/docs/0xjs/0.0.1/async.md')
-rw-r--r--packages/website/md/docs/0xjs/0.0.1/async.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/packages/website/md/docs/0xjs/0.0.1/async.md b/packages/website/md/docs/0xjs/0.0.1/async.md
new file mode 100644
index 000000000..8abaef331
--- /dev/null
+++ b/packages/website/md/docs/0xjs/0.0.1/async.md
@@ -0,0 +1,26 @@
+0x.js is a promise-based library. This means that whenever an asynchronous call is required, the library method will return a native Javascript promise. You can therefore choose between using `promise` or `async/await` syntax when calling our async methods.
+
+_Async/await syntax (recommended):_
+
+```javascript
+try {
+ var availableAddresses = await zeroEx.getAvailableAddressesAsync();
+} catch (error) {
+ console.log('Caught error: ', error);
+}
+```
+
+_Promise syntax:_
+
+```javascript
+zeroEx
+ .getAvailableAddressesAsync()
+ .then(function(availableAddresses) {
+ console.log(availableAddresses);
+ })
+ .catch(function(error) {
+ console.log('Caught error: ', error);
+ });
+```
+
+As is the convention with promise-based libraries, if an error occurs, it is thrown. It is the callers responsibility to catch thrown errors and to handle them appropriately.