From 2df569b72727bf4face8ad5f223535657f99db39 Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Mon, 17 Sep 2018 21:33:50 +0000 Subject: Folder 1.0.0 -> 1.0.1 --- packages/website/md/docs/0xjs/1.0.0/async.md | 31 ----------------- .../website/md/docs/0xjs/1.0.0/installation.md | 40 ---------------------- .../website/md/docs/0xjs/1.0.0/introduction.md | 1 - packages/website/md/docs/0xjs/1.0.0/versioning.md | 1 - packages/website/md/docs/0xjs/1.0.1/async.md | 31 +++++++++++++++++ .../website/md/docs/0xjs/1.0.1/installation.md | 40 ++++++++++++++++++++++ .../website/md/docs/0xjs/1.0.1/introduction.md | 1 + packages/website/md/docs/0xjs/1.0.1/versioning.md | 1 + .../ts/containers/zero_ex_js_documentation.ts | 10 +++--- 9 files changed, 78 insertions(+), 78 deletions(-) delete mode 100644 packages/website/md/docs/0xjs/1.0.0/async.md delete mode 100644 packages/website/md/docs/0xjs/1.0.0/installation.md delete mode 100644 packages/website/md/docs/0xjs/1.0.0/introduction.md delete mode 100644 packages/website/md/docs/0xjs/1.0.0/versioning.md create mode 100644 packages/website/md/docs/0xjs/1.0.1/async.md create mode 100644 packages/website/md/docs/0xjs/1.0.1/installation.md create mode 100644 packages/website/md/docs/0xjs/1.0.1/introduction.md create mode 100644 packages/website/md/docs/0xjs/1.0.1/versioning.md diff --git a/packages/website/md/docs/0xjs/1.0.0/async.md b/packages/website/md/docs/0xjs/1.0.0/async.md deleted file mode 100644 index bd5ae9d8a..000000000 --- a/packages/website/md/docs/0xjs/1.0.0/async.md +++ /dev/null @@ -1,31 +0,0 @@ -0x packages are promise-based libraries. 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 { - const signature = await signatureUtils.ecSignOrderHashAsync( - providerEngine, - orderHashHex, - maker, - SignerType.Default, - ); -} catch (error) { - console.log('Caught error: ', error); -} -``` - -_Promise syntax:_ - -```javascript -signatureUtils - .ecSignOrderHashAsync(providerEngine, orderHashHex, maker, SignerType.Default) - .then(function(signature) { - console.log(signature); - }) - .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. diff --git a/packages/website/md/docs/0xjs/1.0.0/installation.md b/packages/website/md/docs/0xjs/1.0.0/installation.md deleted file mode 100644 index 74c902afd..000000000 --- a/packages/website/md/docs/0xjs/1.0.0/installation.md +++ /dev/null @@ -1,40 +0,0 @@ -0x.js ships as both a [UMD](https://github.com/umdjs/umd) module and a [CommonJS](https://en.wikipedia.org/wiki/CommonJS) package. - -#### CommonJS _(recommended)_: - -**Install** - -```bash -npm install 0x.js --save -``` - -**Import** - -```javascript -import { - assetDataUtils, - BigNumber, - ContractWrappers, - generatePseudoRandomSalt, - Order, - orderHashUtils, - signatureUtils, - SignerType, -} from '0x.js'; -``` - -#### UMD: - -**Install** - -Download the UMD module from our [releases page](https://github.com/0xProject/0x-monorepo/releases) and add it to your project. - -**Import** - -```html - -``` - -### Wiki - -Check out our [wiki](https://0xproject.com/wiki) for articles on how to get 0x.js setup with Ganache, Infura and more! diff --git a/packages/website/md/docs/0xjs/1.0.0/introduction.md b/packages/website/md/docs/0xjs/1.0.0/introduction.md deleted file mode 100644 index 4d5d314d3..000000000 --- a/packages/website/md/docs/0xjs/1.0.0/introduction.md +++ /dev/null @@ -1 +0,0 @@ -Welcome to the [0x.js](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js) documentation! 0x.js is a Javascript library for interacting with the 0x protocol. With it, you can easily make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721). Functionality includes generating, signing, filling and cancelling orders, verifying an orders signature, setting or checking a users ERC20/ERC721 token balance/allowance and much more. diff --git a/packages/website/md/docs/0xjs/1.0.0/versioning.md b/packages/website/md/docs/0xjs/1.0.0/versioning.md deleted file mode 100644 index 6bae835d3..000000000 --- a/packages/website/md/docs/0xjs/1.0.0/versioning.md +++ /dev/null @@ -1 +0,0 @@ -Since v1.0.0, this package adheres to the [Semantic Versioning 2.0.0](http://semver.org/) specification. The library's public interface includes all the methods, properties and types included in the documentation. We will publish with a major version bump for any breaking change to the public interface, use a minor version bump when introducing new features in a backwards-compatible way, and patch versions when introducing backwards-compatible bug fixes. Because of this, we recommend you import `0x.js` with a caret `^1.0.0` to take advantage of non-breaking bug fixes. diff --git a/packages/website/md/docs/0xjs/1.0.1/async.md b/packages/website/md/docs/0xjs/1.0.1/async.md new file mode 100644 index 000000000..bd5ae9d8a --- /dev/null +++ b/packages/website/md/docs/0xjs/1.0.1/async.md @@ -0,0 +1,31 @@ +0x packages are promise-based libraries. 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 { + const signature = await signatureUtils.ecSignOrderHashAsync( + providerEngine, + orderHashHex, + maker, + SignerType.Default, + ); +} catch (error) { + console.log('Caught error: ', error); +} +``` + +_Promise syntax:_ + +```javascript +signatureUtils + .ecSignOrderHashAsync(providerEngine, orderHashHex, maker, SignerType.Default) + .then(function(signature) { + console.log(signature); + }) + .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. diff --git a/packages/website/md/docs/0xjs/1.0.1/installation.md b/packages/website/md/docs/0xjs/1.0.1/installation.md new file mode 100644 index 000000000..74c902afd --- /dev/null +++ b/packages/website/md/docs/0xjs/1.0.1/installation.md @@ -0,0 +1,40 @@ +0x.js ships as both a [UMD](https://github.com/umdjs/umd) module and a [CommonJS](https://en.wikipedia.org/wiki/CommonJS) package. + +#### CommonJS _(recommended)_: + +**Install** + +```bash +npm install 0x.js --save +``` + +**Import** + +```javascript +import { + assetDataUtils, + BigNumber, + ContractWrappers, + generatePseudoRandomSalt, + Order, + orderHashUtils, + signatureUtils, + SignerType, +} from '0x.js'; +``` + +#### UMD: + +**Install** + +Download the UMD module from our [releases page](https://github.com/0xProject/0x-monorepo/releases) and add it to your project. + +**Import** + +```html + +``` + +### Wiki + +Check out our [wiki](https://0xproject.com/wiki) for articles on how to get 0x.js setup with Ganache, Infura and more! diff --git a/packages/website/md/docs/0xjs/1.0.1/introduction.md b/packages/website/md/docs/0xjs/1.0.1/introduction.md new file mode 100644 index 000000000..4d5d314d3 --- /dev/null +++ b/packages/website/md/docs/0xjs/1.0.1/introduction.md @@ -0,0 +1 @@ +Welcome to the [0x.js](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js) documentation! 0x.js is a Javascript library for interacting with the 0x protocol. With it, you can easily make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721). Functionality includes generating, signing, filling and cancelling orders, verifying an orders signature, setting or checking a users ERC20/ERC721 token balance/allowance and much more. diff --git a/packages/website/md/docs/0xjs/1.0.1/versioning.md b/packages/website/md/docs/0xjs/1.0.1/versioning.md new file mode 100644 index 000000000..6bae835d3 --- /dev/null +++ b/packages/website/md/docs/0xjs/1.0.1/versioning.md @@ -0,0 +1 @@ +Since v1.0.0, this package adheres to the [Semantic Versioning 2.0.0](http://semver.org/) specification. The library's public interface includes all the methods, properties and types included in the documentation. We will publish with a major version bump for any breaking change to the public interface, use a minor version bump when introducing new features in a backwards-compatible way, and patch versions when introducing backwards-compatible bug fixes. Because of this, we recommend you import `0x.js` with a caret `^1.0.0` to take advantage of non-breaking bug fixes. diff --git a/packages/website/ts/containers/zero_ex_js_documentation.ts b/packages/website/ts/containers/zero_ex_js_documentation.ts index c6aee571d..2a3afd86c 100644 --- a/packages/website/ts/containers/zero_ex_js_documentation.ts +++ b/packages/website/ts/containers/zero_ex_js_documentation.ts @@ -15,11 +15,11 @@ const AsyncMarkdownV0 = require('md/docs/0xjs/0.0.1/async'); const ErrorsMarkdownV0 = require('md/docs/0xjs/0.0.1/errors'); const versioningMarkdownV0 = require('md/docs/0xjs/0.0.1/versioning'); -const IntroMarkdownV1 = require('md/docs/0xjs/1.0.0/introduction'); -const InstallationMarkdownV1 = require('md/docs/0xjs/1.0.0/installation'); -const AsyncMarkdownV1 = require('md/docs/0xjs/1.0.0/async'); +const IntroMarkdownV1 = require('md/docs/0xjs/1.0.1/introduction'); +const InstallationMarkdownV1 = require('md/docs/0xjs/1.0.1/installation'); +const AsyncMarkdownV1 = require('md/docs/0xjs/1.0.1/async'); const ErrorsMarkdownV1 = ErrorsMarkdownV0; -const versioningMarkdownV1 = require('md/docs/0xjs/1.0.0/versioning'); +const versioningMarkdownV1 = require('md/docs/0xjs/1.0.1/versioning'); /* tslint:enable:no-var-requires */ @@ -51,7 +51,7 @@ const docsInfoConfig: DocsInfoConfig = { [markdownSections.async]: AsyncMarkdownV0, [markdownSections.errors]: ErrorsMarkdownV0, }, - '1.0.0': { + '1.0.1': { [markdownSections.introduction]: IntroMarkdownV1, [markdownSections.installation]: InstallationMarkdownV1, [markdownSections.versioning]: versioningMarkdownV1, -- cgit v1.2.3