EventWatcherResult

Import from: @xbbg/xnews

Defined in: src/types.ts (declaration: types.d.ts:422)

Watcher result: full snapshot plus only the ids that appeared on this poll.

Extends

• EventProviderResult<Provider>

Type Parameters

Provider

Provider extends string = BuiltInEventProvider

Properties

addedEvents

readonly addedEvents: readonly EventRecord<Provider>[]

Defined in: src/types.ts (declaration: types.d.ts:423)

---

dataset

readonly dataset: string

Defined in: src/types.ts (declaration: types.d.ts:408)

Inherited from

EventProviderResult.dataset

---

durationMs

readonly durationMs: number

Defined in: src/types.ts (declaration: types.d.ts:417)

Inherited from

EventProviderResult.durationMs

---

error?

readonly optional error?: ProviderError

Defined in: src/types.ts (declaration: types.d.ts:419)

Inherited from

EventProviderResult.error

---

eventCount

readonly eventCount: number

Defined in: src/types.ts (declaration: types.d.ts:414)

Inherited from

EventProviderResult.eventCount

---

events

readonly events: readonly EventRecord<Provider>[]

Defined in: src/types.ts (declaration: types.d.ts:413)

Full current-state event set; identical to snapshot.events when present.

Inherited from

EventProviderResult.events

---

fetchedAt

readonly fetchedAt: string

Defined in: src/types.ts (declaration: types.d.ts:416)

Inherited from

EventProviderResult.fetchedAt

---

provider

readonly provider: Provider

Defined in: src/types.ts (declaration: types.d.ts:407)

Inherited from

EventProviderResult.provider

---

requestUrls

readonly requestUrls: readonly string[]

Defined in: src/types.ts (declaration: types.d.ts:418)

Inherited from

EventProviderResult.requestUrls

---

snapshot?

readonly optional snapshot?: EventSnapshot<Provider>

Defined in: src/types.ts (declaration: types.d.ts:411)

Present unless the fetch failed or found nothing active.

Inherited from

EventProviderResult.snapshot

---

status

readonly status: ProviderStatus

Defined in: src/types.ts (declaration: types.d.ts:409)

Inherited from

EventProviderResult.status

---

warnings

readonly warnings: readonly string[]

Defined in: src/types.ts (declaration: types.d.ts:415)

Inherited from

EventProviderResult.warnings