Merge pull request #102 from amarzavery/disconnect

minor type definition and doc updates

Author: amarzavery

README.md

@@ -336,8 +336,8 @@ Raised when the remote peer indicates the connection is closed.
 ##### connection_error
 
 Raised when the remote peer indicates the connection is closed and
-specifies an error. A connection_close event will always follow this
-event, so it only needs to be implemented if there is specific actions
+specifies an error. A `connection_close` event will always follow this
+event, so it only needs to be implemented if there are specific actions
 to be taken on a close with an error as opposed to a close. The error
 is available as a property on the event context.
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "rhea",
-    "version": "0.2.16",
+    "version": "0.2.17",
     "description": "reactive AMQP 1.0 library",
     "homepage": "http://github.com/amqp/rhea",
     "license": "Apache-2.0",

tsconfig.json

@@ -9,16 +9,6 @@
     "strict": true,
     "declaration": true,
     "declarationDir": "./typings",
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "es5",
-      "es6",
-      "es7",
-      "esnext",
-      "esnext.asynciterable",
-      "es2015.iterable"
-    ]
   },
   "compileOnSave": true,
   "include": [

typings/connection.d.ts

@@ -9,6 +9,7 @@ import { frames } from "./frames";
 import { EventEmitter } from "events";
 import { Container } from "./container";
 import { PeerCertificate } from "tls";
+import { ConnectionError } from "./errors";
 
 /**
  * Describes the signature of the event handler for any event emitted by rhea.
@@ -472,7 +473,7 @@ export interface EventContext {
    */
   container: Container;
   /**
-   * @property {Session} session The amqp session link that was created on the amqp connection.
+   * @property {Session} [session] The amqp session link that was created on the amqp connection.
    */
   session?: Session;
   /**
@@ -493,9 +494,17 @@ export interface EventContext {
    */
   sender?: Sender;
   /**
-   * @property {Error} error An optional error object.
+   * @property {Error | ConnectionError} [error] An optional error object.
+   * - On `connection_error` event this property will be present. It will have the same information as
+   * `connection.error` but the type will be `ConnectionError`.
+   * - An error with SASL will be available through this property, but not through `connection.error`
+   * (as the amqp connection was never established).
+   * - On `disconnected` event the context will have an error property that will be of type
+   * `Error` (or some subclass) as emitted by the underlying socket.
+   * - The `session_error`, `sender_error` and `receiver_error` events will not have this (`error`)
+   * property on the EventContext.
    */
-  error?: Error;
+  error?: Error | ConnectionError;
   /**
    * @property {boolean} [reconnecting] The value is true if the library is attempting to automatically
    * reconnect and false if it has reached the reconnect limit. If reconnect has not been enabled
@@ -546,7 +555,7 @@ export declare interface Connection extends EventEmitter {
   open_receiver(options?: ReceiverOptions | string): Receiver;
   get_option(name: string, default_value: any): any;
   send(msg: Message): Delivery;
-  get_error(): Error | undefined;
+  get_error(): ConnectionError | undefined;
   open(): void;
   close(error?: AmqpError): void;
   is_open(): boolean;

typings/index.d.ts

@@ -6,7 +6,7 @@ export {
   EndpointOptions, LinkOptions, ReceiverOptions, SenderOptions, TerminusOptions,
   ConnectionEvents, MessageHeader, OnAmqpEvent, Source
 } from "./connection";
-export { ConnectionError, ProtocolError, TypeError } from "./errors";
+export { ConnectionError, ProtocolError, TypeError, SimpleError } from "./errors";
 export { Delivery, Session, SessionEvents } from "./session";
 export { message as MessageUtil } from "./message";
 export { filter as Filter } from "./filter"