Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
amarzavery authored and grs committed Aug 7, 2018
1 parent e2a663f commit 42423bc
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions typings/connection.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
10 changes: 5 additions & 5 deletions typings/link.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
10 changes: 5 additions & 5 deletions typings/session.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 42423bc

Please sign in to comment.