Class ListSourceDrainer

Hierarchy

ListSourceDrainer

Index

Constructors

Properties

_disposer _filled _filter _messages _minReadingSize _newMessagesAvailable _requester newMessagesSubscriptions requestCriticalSection source

Accessors

guaranteed messages newMessagesCount readToBottom

Methods

connect drainNewMessages filter loadNextPage onNewMessages recalcMessages request requestRaw resetFilter

Constructors

constructor

new ListSourceDrainer(source: ListSourceMultiplexer): ListSourceDrainer
Parameters
- source: ListSourceMultiplexer
Returns ListSourceDrainer
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:27

Properties

`Private` _disposer

_disposer: null | (() => void) = null

`Private` _filled

_filled: number = 0

`Private` _filter

_filter: null | ((m: IMessageWithSource) => void) = null

`Private` _messages

_messages: IMessageWithSource[] = []

`Private` _minReadingSize

_minReadingSize: number = 10

`Private` _newMessagesAvailable

_newMessagesAvailable: number = 0

`Private` _requester

_requester: null | ((from: IMessage<any>, limit: number) => Promise<void>) = null

`Protected` newMessagesSubscriptions

newMessagesSubscriptions: Set<{
callback: (() => void);
name: string;
}> = ...

`Private` requestCriticalSection

requestCriticalSection: CriticalSection = ...

`Readonly` source

source: ListSourceMultiplexer

Accessors

guaranteed

get guaranteed(): number
Returns number
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:29

messages

get messages(): IMessageWithSource[]
Returns IMessageWithSource[]
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:52

newMessagesCount

get newMessagesCount(): number
Returns number
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:60

readToBottom

get readToBottom(): boolean
Returns boolean
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:56

Methods

connect

connect(newMessagesCallback: (() => void), subscriptionName?: string): Promise<{
    dispose: (() => void);
    loadNextPage: ((...args: []) => Promise<void>);
    request: ((...args: [from: null | IMessage<any>, limit: number]) => Promise<void>);
}>
Parameters
- newMessagesCallback: (() => void)
  - - (): void
    - Returns void
- subscriptionName: string = 'YlideMailbox'
Returns Promise<{
    dispose: (() => void);
    loadNextPage: ((...args: []) => Promise<void>);
    request: ((...args: [from: null | IMessage<any>, limit: number]) => Promise<void>);
}>
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:150

drainNewMessages

drainNewMessages(): Promise<void>
Returns Promise<void>
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:64

`Private` filter

filter(m: IMessageWithSource): true | void
Parameters
- m: IMessageWithSource
Returns true | void
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:33

loadNextPage

loadNextPage(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:140

`Private` onNewMessages

onNewMessages(): void
Returns void
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:74

recalcMessages

recalcMessages(): void
Returns void
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:48

`Private` request

request(name: string, from: null | IMessage<any>, limit?: number): Promise<void>
Parameters
- name: string
- from: null | IMessage<any>
- limit: number = 10
Returns Promise<void>
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:117

`Private` requestRaw

requestRaw(name: string, from: null | IMessage<any>, limit?: number): Promise<void>
Parameters
- name: string
- from: null | IMessage<any>
- limit: number = 10
Returns Promise<void>
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:79

resetFilter

resetFilter(newFilter: null | ((m: IMessageWithSource) => void)): Promise<void>
Parameters
- newFilter: null | ((m: IMessageWithSource) => void)
Returns Promise<void>
- Defined in src/messages-list/high-level/ListSourceDrainer.ts:37

Generated using TypeDoc