Skip to content

Commit 42423bc

Browse files
amarzaverygrs
authored andcommitted
doc update
1 parent e2a663f commit 42423bc

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

typings/connection.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -591,8 +591,8 @@ export declare interface Connection extends EventEmitter {
591591
is_open(): boolean;
592592
is_remote_open(): boolean;
593593
/**
594-
* Determines whether the close for connection was initiated by the client.
595-
* @returns {boolean} `true` - close was initiated by the client, `false` otherwise.
594+
* Determines whether both local and remote endpoints are closed.
595+
* @returns {boolean} `true` - closed, `false` otherwise.
596596
*/
597597
is_closed(): boolean;
598598
create_session(): Session;

typings/link.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,14 @@ export declare interface link extends EventEmitter {
4242
is_open(): boolean;
4343
is_remote_open(): boolean;
4444
/**
45-
* Determines whether the close for link or it's underlying session or it's
46-
* underlying connection was initiated by the client.
47-
* @returns {boolean} `true` - close was initiated by the client, `false` otherwise.
45+
* Determines whether both local and remote endpoint for link or it's underlying session
46+
* or it's underlying connection are closed.
47+
* @returns {boolean} `true` - closed, `false` otherwise.
4848
*/
4949
is_closed(): boolean;
5050
/**
51-
* Determines whether the close for just the link itself was initiated by the client.
52-
* @returns {boolean} `true` - close was initiated by the client, `false` otherwise.
51+
* Determines whether both local and remote endpoint for just the link itself are closed.
52+
* @returns {boolean} `true` - closed, `false` otherwise.
5353
*/
5454
is_itself_closed(): boolean;
5555
has_credit(): boolean;

typings/session.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ export declare interface Session extends EventEmitter {
5353
is_open(): boolean;
5454
is_remote_open(): boolean;
5555
/**
56-
* Determines whether the close for session or it's underlying connection
57-
* was initiated by the client.
58-
* @returns {boolean} `true` - close was initiated by the client, `false` otherwise.
56+
* Determines whether both local and remote endpoint for session or it's underlying
57+
* connection are closed.
58+
* @returns {boolean} `true` - closed, `false` otherwise.
5959
*/
6060
is_closed(): boolean;
6161
/**
62-
* Determines whether the close for just the session itself was initiated by the client.
63-
* @returns {boolean} `true` - close was initiated by the client, `false` otherwise.
62+
* Determines whether both local and remote endpoint for just the session itself are closed.
63+
* @returns {boolean} `true` - closed, `false` otherwise.
6464
*/
6565
is_itself_closed(): boolean;
6666
remove(): void;

0 commit comments

Comments
 (0)