Skip to content

Commit

Permalink
Merge pull request #1752 from ably/fix-wrong-docstring-for-release
Browse files Browse the repository at this point in the history
docs: fix docstring for `release` method
  • Loading branch information
ttypic authored Apr 25, 2024
2 parents c8bc961 + 718d901 commit dba5fa0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion ably.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2190,7 +2190,7 @@ export declare interface Channels<T> {
*/
getDerived(name: string, deriveOptions: DeriveOptions, channelOptions?: ChannelOptions): T;
/**
* Releases a {@link Channel} or {@link RealtimeChannel} object, deleting it, and enabling it to be garbage collected. It also removes any listeners associated with the channel. To release a channel, the {@link ChannelState} must be `INITIALIZED`, `DETACHED`, or `FAILED`.
* Releases a {@link Channel} or {@link RealtimeChannel} object, deleting it, and enabling it to be garbage collected. To release a channel, the {@link ChannelState} must be `INITIALIZED`, `DETACHED`, or `FAILED`.
*
* @param name - The channel name.
*/
Expand Down

0 comments on commit dba5fa0

Please sign in to comment.