prettier

Author: callum-oakley

.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  semi: false,
+}

README.md

@@ -35,19 +35,19 @@ Then to build the file bundle for Parse Cloud:
 To import `Pusher`:
 
 ```js
-var Pusher = require('cloud/modules/node_modules/pusher/parse');
+var Pusher = require("cloud/modules/node_modules/pusher/parse")
 ```
 
 ## Importing
 
 It's possible to use pusher-http-node with typescript or javascript.
 
 ```javascript
-const Pusher = require('pusher');
+const Pusher = require("pusher")
 ```
 
 ```typescript
-import * as Pusher from 'pusher';
+import * as Pusher from "pusher"
 ```
 
 All external APIs should have types in index.d.ts.
@@ -57,41 +57,41 @@ All external APIs should have types in index.d.ts.
 There are 3 ways to configure the client. First one is just using the Pusher constructor:
 
 ```javascript
-var Pusher = require('pusher');
+var Pusher = require("pusher")
 
 var pusher = new Pusher({
-  appId: 'APP_ID',
-  key: 'APP_KEY',
-  secret: 'SECRET_KEY',
+  appId: "APP_ID",
+  key: "APP_KEY",
+  secret: "SECRET_KEY",
   useTLS: USE_TLS, // optional, defaults to false
-  cluster: 'CLUSTER', // if `host` is present, it will override the `cluster` option.
-  host: 'HOST', // optional, defaults to api.pusherapp.com
+  cluster: "CLUSTER", // if `host` is present, it will override the `cluster` option.
+  host: "HOST", // optional, defaults to api.pusherapp.com
   port: PORT, // optional, defaults to 80 for non-TLS connections and 443 for TLS connections
   encryptionMasterKeyBase64: ENCRYPTION_MASTER_KEY, // a base64 string which encodes 32 bytes, used to derive the per-channel encryption keys (see below!)
-});
+})
 ```
 
 For specific clusters, you can use the `forCluster` function. This is the same as using the `cluster` option in the constructor.
 
 ```javascript
-var Pusher = require('pusher');
+var Pusher = require("pusher")
 
 var pusher = Pusher.forCluster("CLUSTER", {
-  appId: 'APP_ID',
-  key: 'APP_KEY',
-  secret: 'SECRET_KEY',
+  appId: "APP_ID",
+  key: "APP_KEY",
+  secret: "SECRET_KEY",
   useTLS: USE_TLS, // optional, defaults to false
   port: PORT, // optional, defaults to 80 for non-TLS connections and 443 for TLS connections
   encryptionMasterKeyBase64: ENCRYPTION_MASTER_KEY, // a base64 string which encodes 32 bytes, used to derive the per-channel encryption keys (see below!)
-});
+})
 ```
 
 You can also specify auth and endpoint options by passing an URL:
 
 ```javascript
-var Pusher = require('pusher');
+var Pusher = require("pusher")
 
-var pusher = Pusher.forURL("SCHEME://APP_KEY:SECRET_KEY@HOST:PORT/apps/APP_ID");
+var pusher = Pusher.forURL("SCHEME://APP_KEY:SECRET_KEY@HOST:PORT/apps/APP_ID")
 ```
 
 You can pass the optional second argument with options, as in `forCluster` function.
@@ -104,14 +104,14 @@ variable to such URL, if you have the Pusher addon installed.
 There are a few additional options that can be used in all above methods:
 
 ```javascript
-var Pusher = require('pusher');
+var Pusher = require("pusher")
 
 var pusher = new Pusher({
   // you can set other options in any of the 3 ways described above
-  proxy: 'HTTP_PROXY_URL', // optional, URL to proxy the requests through
+  proxy: "HTTP_PROXY_URL", // optional, URL to proxy the requests through
   timeout: TIMEOUT, // optional, timeout for all requests in milliseconds
-  keepAlive: KEEP_ALIVE // optional, enables keep-alive, defaults to false
-});
+  keepAlive: KEEP_ALIVE, // optional, enables keep-alive, defaults to false
+})
 ```
 
 ## Usage
@@ -134,20 +134,22 @@ In case accessing data for invalid WebHooks, an Pusher.WebHookError exception wi
 
 ### Publishing events
 
-To send an event to one or more channels use the trigger function. Channel names can contain only characters which are alphanumeric, '_' or '-' and have to be at most 200 characters long. Event name can be at most 200 characters long too.
+To send an event to one or more channels use the trigger function. Channel names can contain only characters which are alphanumeric, '\_' or '-' and have to be at most 200 characters long. Event name can be at most 200 characters long too.
 
 #### Single channel
 
 ```javascript
-pusher.trigger('channel-1', 'test_event', { message: "hello world" });
+pusher.trigger("channel-1", "test_event", { message: "hello world" })
 ```
 
 #### Multiple channels
 
 To trigger an event on multiple channels:
 
 ```javascript
-pusher.trigger([ 'channel-1', 'channel-2' ], 'test_event', { message: "hello world" });
+pusher.trigger(["channel-1", "channel-2"], "test_event", {
+  message: "hello world",
+})
 ```
 
 You can trigger an event to at most 100 channels at once. Passing more than 100 channels will cause an exception to be thrown.
@@ -157,18 +159,20 @@ You can trigger an event to at most 100 channels at once. Passing more than 100
 If you wish to send multiple events in a single HTTP request, you can pass an array of events to `pusher.triggerBatch`. You can send up to a maximum of 10 events at once.
 
 ```javascript
-var events = [{
-  channel: "channel-1",
-  name: "test-event-1",
-  data: {message: "hello world"}
-},
-{
-  channel: "channel-2",
-  name: "test-event-2",
-  data: {message: "hello another world"}
-}];
-
-pusher.triggerBatch(events);
+var events = [
+  {
+    channel: "channel-1",
+    name: "test-event-1",
+    data: { message: "hello world" },
+  },
+  {
+    channel: "channel-2",
+    name: "test-event-2",
+    data: { message: "hello another world" },
+  },
+]
+
+pusher.triggerBatch(events)
 ```
 
 You can trigger a batch of up to 10 events.
@@ -178,8 +182,8 @@ You can trigger a batch of up to 10 events.
 In order to avoid the client that triggered the event from also receiving it, the `trigger` function takes an optional `socketId` parameter. For more informaiton see: <http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients>.
 
 ```javascript
-var socketId = '1302.1081607';
-pusher.trigger(channel, event, data, socketId);
+var socketId = "1302.1081607"
+pusher.trigger(channel, event, data, socketId)
 ```
 
 ### End-to-end encryption [BETA]
@@ -199,24 +203,26 @@ This library supports end-to-end encryption of your private channels. This means
 
    ```javascript
    var pusher = new Pusher({
-     appId: 'APP_ID',
-     key: 'APP_KEY',
-     secret: 'SECRET_KEY',
+     appId: "APP_ID",
+     key: "APP_KEY",
+     secret: "SECRET_KEY",
      useTLS: true,
-     encryptionMasterKeyBase64: '<KEY GENERATED BY PREVIOUS COMMAND>',
-   });
+     encryptionMasterKeyBase64: "<KEY GENERATED BY PREVIOUS COMMAND>",
+   })
    ```
 
 3. Channels where you wish to use end-to-end encryption should be prefixed with `private-encrypted-`.
 
 4. Subscribe to these channels in your client, and you're done! You can verify it is working by checking out the debug console on the [https://dashboard.pusher.com/](dashboard) and seeing the scrambled ciphertext.
 
-**Important note: This will __not__ encrypt messages on channels that are not prefixed by `private-encrypted-`.**
+**Important note: This will **not** encrypt messages on channels that are not prefixed by `private-encrypted-`.**
 
 **Limitation**: you cannot trigger a single event on multiple channels in a call to `trigger`, e.g.
 
 ```javascript
-pusher.trigger([ 'channel-1', 'private-encrypted-channel-2' ], 'test_event', { message: "hello world" });
+pusher.trigger(["channel-1", "private-encrypted-channel-2"], "test_event", {
+  message: "hello world",
+})
 ```
 
 Rationale: the methods in this library map directly to individual Channels HTTP API requests. If we allowed triggering a single event on multiple channels (some encrypted, some unencrypted), then it would require two API requests: one where the event is encrypted to the encrypted channels, and one where the event is unencrypted for unencrypted channels.
@@ -226,7 +232,7 @@ Rationale: the methods in this library map directly to individual Channels HTTP
 To authorise your users to access private channels on Pusher Channels, you can use the `authenticate` function:
 
 ```javascript
-var auth = pusher.authenticate(socketId, channel);
+var auth = pusher.authenticate(socketId, channel)
 ```
 
 For more information see: <http://pusher.com/docs/authenticating_users>
@@ -255,48 +261,54 @@ For more information see: <http://pusher.com/docs/authenticating_users>
 It's possible to query the state of the application using the `pusher.get` function.
 
 ```javascript
-pusher.get({ path: path, params: params }, callback);
+pusher.get({ path: path, params: params }, callback)
 ```
 
 The `path` property identifies the resource that the request should be made to and the `params` property should be a map of additional query string key and value pairs.
 
 Params can't include following keys:
+
 - auth_key
 - auth_timestamp
 - auth_version
 - auth_signature
 - body_md5
 
 The following example provides the signature of the callback and an example of parsing the result:
+
 ```javascript
-pusher.get({ path: '/channels', params: {} }, function(error, request, response) {
+pusher.get({ path: "/channels", params: {} }, function (
+  error,
+  request,
+  response
+) {
   if (response.statusCode === 200) {
-    var result = JSON.parse(response.body);
-    var channelsInfo = result.channels;
+    var result = JSON.parse(response.body)
+    var channelsInfo = result.channels
   }
-});
+})
 ```
 
 #### Get the list of channels in an application
 
 ```javascript
-pusher.get({ path: '/channels', params: params }, callback);
+pusher.get({ path: "/channels", params: params }, callback)
 ```
 
 Information on the optional `params` and the structure of the returned JSON is defined in the [REST API reference](http://pusher.com/docs/rest_api#method-get-channels).
 
 #### Get the state of a channel
 
 ```javascript
-pusher.get({ path: '/channels/[channel_name]', params: params }, callback);
+pusher.get({ path: "/channels/[channel_name]", params: params }, callback)
 ```
 
 Information on the optional `params` option property and the structure of the returned JSON is defined in the [REST API reference](http://pusher.com/docs/rest_api#method-get-channel).
 
 #### Get the list of users in a presence channel
 
 ```javascript
-pusher.get({ path: '/channels/[channel_name]/users' }, callback);
+pusher.get({ path: "/channels/[channel_name]/users" }, callback)
 ```
 
 The `channel_name` in the path must be a [presence channel](http://pusher.com/docs/presence). The structure of the returned JSON is defined in the [REST API reference](http://pusher.com/docs/rest_api#method-get-users).
@@ -306,16 +318,18 @@ The `channel_name` in the path must be a [presence channel](http://pusher.com/do
 The library provides a simple helper for WebHooks, which can be accessed via Pusher instances:
 
 ```javascript
-var webhook = pusher.webhook(request);
+var webhook = pusher.webhook(request)
 ```
 
 Requests must expose following fields:
+
 - headers - object with request headers indexed by lowercase header names
 - rawBody - string with the WebHook request body
 
 Since neither Node.js nor express provide the body in the request, your application needs to read it and assign to the request object. See examples/webhook_endpoint.js for a simple webhook endpoint implementation using the express framework.
 
 Headers object must contain following headers:
+
 - x-pusher-key - application key, sent by Channels
 - x-pusher-signature - WebHook signature, generated by Channels
 - content-type - must be set to application/json, what Channels does
@@ -329,11 +343,14 @@ Validates the content type, body format and signature of the WebHook and returns
 Accepts an optional parameter containing additional application tokens (useful e.g. during migrations):
 
 ```javascript
-var webhook = pusher.webhook(request);
+var webhook = pusher.webhook(request)
 // will check only the key and secret assigned to the pusher object:
-webhook.isValid();
+webhook.isValid()
 // will also check two additional tokens:
-webhook.isValid([{ key: "x1", secret: "y1" }, { key: "x2", secret: "y2" }]);
+webhook.isValid([
+  { key: "x1", secret: "y1" },
+  { key: "x2", secret: "y2" },
+])
 ```
 
 #### getData
@@ -342,7 +359,7 @@ Returns the parsed WebHook body. Throws a Pusher.WebHookError if the WebHook is
 
 ```javascript
 // will return an object with the WebHook data
-webhook.getData();
+webhook.getData()
 ```
 
 Please read [the WebHooks documentation](http://pusher.com/docs/webhooks) to find out what fields are included in the body.
@@ -353,7 +370,7 @@ Returns events included in the WebHook as an array. Throws a Pusher.WebHookError
 
 ```javascript
 // will return an array with the events
-webhook.getEvents();
+webhook.getEvents()
 ```
 
 #### getTime
@@ -362,7 +379,7 @@ Returns the Date object for the time when the WebHook was sent from Channels. Th
 
 ```javascript
 // will return a Date object
-webhook.getTime();
+webhook.getTime()
 ```
 
 ### Generating REST API signatures
@@ -371,11 +388,11 @@ If you wanted to send the REST API requests manually (e.g. using a different HTT
 
 ```javascript
 pusher.createSignedQueryString({
-  method: "POST",                                              // the HTTP request method
-  path: "/apps/3/events",                                      // the HTTP request path
-  body: '{"name":"foo","channel":"donuts","data":"2-for-1"}',  // optional, the HTTP request body
-  params: {},                                                  // optional, the query params
-});
+  method: "POST", // the HTTP request method
+  path: "/apps/3/events", // the HTTP request path
+  body: '{"name":"foo","channel":"donuts","data":"2-for-1"}', // optional, the HTTP request body
+  params: {}, // optional, the query params
+})
 ```
 
 The `params` object can't contain following keys, as they are used to sign the request:
@@ -410,8 +427,9 @@ app credentials, like following:
 ## Credits
 
 This library is based on the work of:
-* Christian Bäuerlein and his library pusher.
-* Jaewoong Kim and the node-pusher library.
+
+- Christian Bäuerlein and his library pusher.
+- Jaewoong Kim and the node-pusher library.
 
 ## License