Skip to content

Commit

Permalink
bump version to v3.3.2 and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tedeh committed Jun 8, 2020
1 parent 8517ef0 commit c9c47a5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Uses the same options as [tls.connect][nodejs_docs_tls_connect].

##### Client.browser

The browser client is a simplified version of the regular client for use browser-side. It does not have any dependencies on node.js core libraries, but does depend on `uuid` and parts of the `lodash` package. It also does not know how to "send" a request to a server like the other clients.
The browser client is a simplified version of the regular client for use browser-side. It does not have any dependencies on node.js core libraries, but does depend on the `uuid` package for generating request ids. It also does not know how to "send" a request to a server like the other clients.

Because it does not depend on any core libraries, the browser client is **not** an instance of `JaysonClient` or `EventEmitter` and therefore does **not** emit any of the normal request events that the other clients do.

Expand All @@ -258,6 +258,8 @@ The reason for dealing with strings is to support the `reviver` and `replacer` o

This client example in [examples/browser_client/client.js](examples/browser_client/client.js) below uses [node-fetch](https://github.com/bitinn/node-fetch) in the transport function, but a dropin replacement for use in an *actual* browser could instead use [whatwg-fetch](https://github.com/github/fetch/issues/184).

The browser client has a separate TypeScript type declaration available in `jayson/lib/client/browser/index.d.ts` which depends on the main Jayson type declaration.

```javascript
'use strict';

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jayson",
"version": "3.3.1",
"version": "3.3.2",
"description": "JSON-RPC 1.0/2.0 compliant server and client",
"license": "MIT",
"keywords": [
Expand Down

0 comments on commit c9c47a5

Please sign in to comment.