From 42423bcd80ad2183afbd76dba1f485a257ce82b4 Mon Sep 17 00:00:00 2001 From: Amar Zavery Date: Tue, 7 Aug 2018 12:36:40 -0700 Subject: [PATCH] doc update --- typings/connection.d.ts | 4 ++-- typings/link.d.ts | 10 +++++----- typings/session.d.ts | 10 +++++----- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/typings/connection.d.ts b/typings/connection.d.ts index 7b79e2c..8b477e8 100644 --- a/typings/connection.d.ts +++ b/typings/connection.d.ts @@ -591,8 +591,8 @@ export declare interface Connection extends EventEmitter { is_open(): boolean; is_remote_open(): boolean; /** - * Determines whether the close for connection was initiated by the client. - * @returns {boolean} `true` - close was initiated by the client, `false` otherwise. + * Determines whether both local and remote endpoints are closed. + * @returns {boolean} `true` - closed, `false` otherwise. */ is_closed(): boolean; create_session(): Session; diff --git a/typings/link.d.ts b/typings/link.d.ts index dbeb89d..34fae22 100644 --- a/typings/link.d.ts +++ b/typings/link.d.ts @@ -42,14 +42,14 @@ export declare interface link extends EventEmitter { is_open(): boolean; is_remote_open(): boolean; /** - * Determines whether the close for link or it's underlying session or it's - * underlying connection was initiated by the client. - * @returns {boolean} `true` - close was initiated by the client, `false` otherwise. + * Determines whether both local and remote endpoint for link or it's underlying session + * or it's underlying connection are closed. + * @returns {boolean} `true` - closed, `false` otherwise. */ is_closed(): boolean; /** - * Determines whether the close for just the link itself was initiated by the client. - * @returns {boolean} `true` - close was initiated by the client, `false` otherwise. + * Determines whether both local and remote endpoint for just the link itself are closed. + * @returns {boolean} `true` - closed, `false` otherwise. */ is_itself_closed(): boolean; has_credit(): boolean; diff --git a/typings/session.d.ts b/typings/session.d.ts index 750d34d..46c46b1 100644 --- a/typings/session.d.ts +++ b/typings/session.d.ts @@ -53,14 +53,14 @@ export declare interface Session extends EventEmitter { is_open(): boolean; is_remote_open(): boolean; /** - * Determines whether the close for session or it's underlying connection - * was initiated by the client. - * @returns {boolean} `true` - close was initiated by the client, `false` otherwise. + * Determines whether both local and remote endpoint for session or it's underlying + * connection are closed. + * @returns {boolean} `true` - closed, `false` otherwise. */ is_closed(): boolean; /** - * Determines whether the close for just the session itself was initiated by the client. - * @returns {boolean} `true` - close was initiated by the client, `false` otherwise. + * Determines whether both local and remote endpoint for just the session itself are closed. + * @returns {boolean} `true` - closed, `false` otherwise. */ is_itself_closed(): boolean; remove(): void;