Type Alias MessageQuery

Describes a query to Hub.getMessages for messages.

type MessageQuery = {
    cid: ChannelRoute | ChannelRoute[];
    limit?: number;
    order?: "ASC" | "DESC";
}

Index

Properties

cid limit? order?

Properties

cid

cid: ChannelRoute | ChannelRoute[]

A argument (or array of arguments) which can resolve to channel names.

`Optional`limit

limit?: number

The number of messages to return.

`Optional`order

order?: "ASC" | "DESC"

Messages are sorted by order of dispatch: ASC is oldest -> newest, DESC is newest -> oldest.