https://github.com/ably/quickstart-js
Contains source code for the JavaScript and Node versions of the Quickstart guide
https://github.com/ably/quickstart-js
Last synced: 9 months ago
JSON representation
Contains source code for the JavaScript and Node versions of the Quickstart guide
- Host: GitHub
- URL: https://github.com/ably/quickstart-js
- Owner: ably
- License: apache-2.0
- Created: 2022-07-20T14:06:07.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T06:46:12.000Z (about 2 years ago)
- Last Synced: 2024-11-17T12:11:54.823Z (over 1 year ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 4
- Watchers: 14
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Ably Quickstart
This repository contains the [Quickstart guide](https://ably.com/docs/quick-start-guide) JavaScript source code for both the callback and promises interfaces.
There are two folders:
* [`promises`](./promises/) contains the Quickstart code in Node.js and JavaScript (in `index.html`) using the promises interface. A [usage guide](./promises/usage.md) is also provided.
* [`callbacks`](./callbacks/) contains the Quickstart code in Node.js using callbacks.
### Authentication
You will generally need to point your client at an authentication server by specifying an `authUrl`. For example:
``` javascript
const ably = new Ably.Realtime.Promise({ authUrl: 'https://ably.com/ably-auth/token/docs' });
```
**NOTE:** The authentication server `https://ably.com/ably-auth/token/docs` is only specified to provide an example and should not be used for production use.