aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/0xjs/async.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon@0xproject.com>2017-11-28 05:02:08 +0800
committerGitHub <noreply@github.com>2017-11-28 05:02:08 +0800
commit4a17f5e82074b01e74ae6982e82419a037eebdb4 (patch)
treeb783366d327d60d8ed69341d4017f7462fd1af40 /packages/website/md/docs/0xjs/async.md
parent694c37150c35f8d9810067b8810764585ac76508 (diff)
parentb04d07815f47018655b70b4152090b566f568af1 (diff)
downloaddexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.tar
dexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.tar.gz
dexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.tar.bz2
dexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.tar.lz
dexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.tar.xz
dexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.tar.zst
dexon-sol-tools-4a17f5e82074b01e74ae6982e82419a037eebdb4.zip
Merge pull request #240 from 0xProject/fix/websiteMdDirectory
Add md directory to website package and change generated docs directory
Diffstat (limited to 'packages/website/md/docs/0xjs/async.md')
-rw-r--r--packages/website/md/docs/0xjs/async.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/packages/website/md/docs/0xjs/async.md b/packages/website/md/docs/0xjs/async.md
new file mode 100644
index 000000000..63924c76c
--- /dev/null
+++ b/packages/website/md/docs/0xjs/async.md
@@ -0,0 +1,23 @@
+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.