ChatPagesStore
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:75
A cursor-paged list: reload() fetches the first page, loadMore() appends the next one.
Extends
Section titled “Extends”Store<ChatPagesState<T>>
Type Parameters
Section titled “Type Parameters”T
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChatPagesStore<
T>(loadPage):ChatPagesStore<T>
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:78
Parameters
Section titled “Parameters”loadPage
Section titled “loadPage”(before) => Promise<Page<T>>
Returns
Section titled “Returns”ChatPagesStore<T>
Overrides
Section titled “Overrides”Store<ChatPagesState<T>>.constructor
Methods
Section titled “Methods”subscribe()
Section titled “subscribe()”
readonlysubscribe(listener): () =>void
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:16
Parameters
Section titled “Parameters”listener
Section titled “listener”Listener
Returns
Section titled “Returns”() => void
Inherited from
Section titled “Inherited from”Store.subscribe
getSnapshot()
Section titled “getSnapshot()”
readonlygetSnapshot():ChatPagesState
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:21
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Store.getSnapshot
cancel()
Section titled “cancel()”cancel():
void
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:24
Ignore the result of any load in flight (e.g. the component unmounted or its inputs changed).
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Store.cancel
reload()
Section titled “reload()”reload():
Promise<void>
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:82
Returns
Section titled “Returns”Promise<void>
loadMore()
Section titled “loadMore()”loadMore():
Promise<void>
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:95
Returns
Section titled “Returns”Promise<void>
mutate()
Section titled “mutate()”
readonlymutate(update):void
Defined in: libs/ccs-chat-user-client/src/react/stores.ts:110
Updates the loaded items locally, e.g. prepend a message from a realtime message.created event.
Parameters
Section titled “Parameters”update
Section titled “update”(items) => T[]
Returns
Section titled “Returns”void