Skip to content

Commit

Permalink
Move RealtimeChannelPromise declaration directly below RealtimeChanne…
Browse files Browse the repository at this point in the history
…lBase

Preparation for merging the *Base and *Promise classes.
  • Loading branch information
lawrence-forooghian committed Jun 27, 2023
1 parent 7261cd1 commit ab14e3d
Showing 1 changed file with 36 additions and 36 deletions.
72 changes: 36 additions & 36 deletions ably.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1999,42 +1999,6 @@ declare namespace Types {
unsubscribe(): void;
}

/**
* Optional parameters for message publishing.
*/
type PublishOptions = {
/**
* See [here](https://faqs.ably.com/why-are-some-rest-publishes-on-a-channel-slow-and-then-typically-faster-on-subsequent-publishes).
*/
quickAck?: boolean;
};

/**
* Contains properties to filter messages with when calling {@link RealtimeChannelPromise.subscribe | `RealtimeChannelPromise.subscribe()`}.
*/
type MessageFilter = {
/**
* Filters messages by a specific message `name`.
*/
name?: string;
/**
* Filters messages by a specific `extras.ref.timeserial` value.
*/
refTimeserial?: string;
/**
* Filters messages by a specific `extras.ref.type` value.
*/
refType?: string;
/**
* Filters messages based on whether they contain an `extras.ref`.
*/
isRef?: boolean;
/**
* Filters messages by a specific message `clientId`.
*/
clientId: string;
};

/**
* Enables messages to be published and subscribed to. Also enables historic messages to be retrieved and provides access to the {@link RealtimePresencePromise} object of a channel.
*/
Expand Down Expand Up @@ -2130,6 +2094,42 @@ declare namespace Types {
whenState(targetState: ChannelState): Promise<ChannelStateChange>;
}

/**
* Optional parameters for message publishing.
*/
type PublishOptions = {
/**
* See [here](https://faqs.ably.com/why-are-some-rest-publishes-on-a-channel-slow-and-then-typically-faster-on-subsequent-publishes).
*/
quickAck?: boolean;
};

/**
* Contains properties to filter messages with when calling {@link RealtimeChannelPromise.subscribe | `RealtimeChannelPromise.subscribe()`}.
*/
type MessageFilter = {
/**
* Filters messages by a specific message `name`.
*/
name?: string;
/**
* Filters messages by a specific `extras.ref.timeserial` value.
*/
refTimeserial?: string;
/**
* Filters messages by a specific `extras.ref.type` value.
*/
refType?: string;
/**
* Filters messages based on whether they contain an `extras.ref`.
*/
isRef?: boolean;
/**
* Filters messages by a specific message `clientId`.
*/
clientId: string;
};

/**
* Creates and destroys {@link ChannelBase} and {@link RealtimeChannelBase} objects.
*/
Expand Down

0 comments on commit ab14e3d

Please sign in to comment.