Class WikimediaStream

A WikimediaStream connects to the Wikimedia Event Platform EventStreams domain (found at https://streams.wikimedia.org) and provides real-time recent changes and actions on Wikimedia wikis.

Hierarchy

EventEmitter
- WikimediaStream

Constructors

constructor

new WikimediaStream(streams, options?): WikimediaStream
Creates a new Wikimedia RecentChanges listener. This will automatically start the stream upon construction; you do not need to call WikimediaStream#open after instantiating this class.
Parameters
- streams: WikimediaEventStream | WikimediaEventStream[]
  The streams to listen to. You may choose any stream defined by the EventStreams documentation page.
- options: WikimediaStreamOptions = {}
  Additional options for the EventSource.
Returns WikimediaStream
- Defined in src/WikimediaStream.ts:432

Properties

`Private` _lastEventId

_lastEventId: string

The last event ID received from the EventSource. Used to seamlessly re-listen to closed connections.

eventSource

eventSource: EventSource

The EventSource which listens to streams on the Wikimedia Event Platform. Uses the eventsource package, which is backwards-compatible with the https://developer.mozilla.org/en-US/docs/Web/API/EventSource|EventSource Web API.

`Private` openCheckInterval

openCheckInterval: Timeout

A NodeJS.Timeout which checks if the EventSource is still open. The interval checks if the EventSource is still open every second, and reopens it if it's closed.

`Private` restartInterval

restartInterval: Timeout

A NodeJS.Timeout which reopens the EventSource every 15 minutes. This ensures that messages are still being received (with a worst possible lag of 15 minutes) even if the EventSource disconnects with no error or close event.

`Private` `Readonly` startingOptions

startingOptions: WikimediaStreamOptions

`Private` `Readonly` streams

The streams that this WikimediaStream is currently listening/will listen to.

`Static` `Readonly` VERSION

VERSION: "3.0.0" = '3.0.0'

The version of this package. Used for the default User-Agent header.

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` defaultUserAgent

defaultUserAgent: string = WikimediaStream.genericUserAgent

The default user agent to be used by wikimedia-streams.

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

`Static` `Readonly` genericUserAgent

genericUserAgent: string = ...

The generic user agent to be used by wikimedia-streams when no default user agent is used or set.

Accessors

lastEventId

get lastEventId(): WikimediaStreamLastEventID[]
Returns WikimediaStreamLastEventID[]
- Defined in src/WikimediaStream.ts:365

status

get status(): EventSourceState
The current status of this stream.

Returns EventSourceState
- Defined in src/WikimediaStream.ts:361

Methods

addListener

addListener<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:246
addListener(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:251
addListener(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:253

attachEventListeners

attachEventListeners(options): void
Parameters
- options: WikimediaStreamOptions
Returns void
- Defined in src/WikimediaStream.ts:580

close

close(): void
Stop listening to the stream.

Returns void
- Defined in src/WikimediaStream.ts:563

emit

emit<T>(eventName, data, event): boolean
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- eventName: T
- data: WikimediaEventStreamEventTypes[T]
- event: MessageEvent<any>
Returns boolean
- Defined in src/WikimediaStream.ts:283
emit(event): this
Parameters
- event: "open" | "close"
Returns this
- Defined in src/WikimediaStream.ts:289
emit(event, error): this
Parameters
- event: "error"
- error: ErrorEvent
Returns this
- Defined in src/WikimediaStream.ts:291

eventNames

eventNames(): ("error" | "open" | "close" | WikimediaEventStream)[]
Returns ("error" | "open" | "close" | WikimediaEventStream)[]
- Defined in src/WikimediaStream.ts:640

filter

filter<T>(eventType): WikimediaStreamFilter<WikimediaEventStreamEventTypes[T], T>
Type Parameters
- T extends WikimediaEventStream
Parameters
- eventType: T
Returns WikimediaStreamFilter<WikimediaEventStreamEventTypes[T], T>
- Defined in src/WikimediaStream.ts:650

getMaxListeners

getMaxListeners(): number
Returns number
- Defined in node_modules/@types/node/events.d.ts:64

listenerCount

listenerCount(event): number
Parameters
- event: "error" | "open" | "close" | WikimediaEventStream
Returns number
- Defined in src/WikimediaStream.ts:293

listeners

listeners(event): Function[]
Parameters
- event: "error" | "open" | "close" | WikimediaEventStream
Returns Function[]
- Defined in src/WikimediaStream.ts:278

off

off<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:255
off(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:260
off(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:262

on

on<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:237
on(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:242
on(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:244

once

once<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:228
once(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:233
once(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:235

open

open(options?): Promise<void>
Start listening to the stream.
Parameters
- options: Omit<WikimediaStreamOptions, "autoStart"> = ...
  Additional options for the EventSource.
Returns Promise<void>
A Promise that resolves once the stream is open.
- Defined in src/WikimediaStream.ts:473

prependListener

prependListener<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:295
prependListener(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:300
prependListener(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:302

prependOnceListener

prependOnceListener<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:304
prependOnceListener(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:309
prependOnceListener(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:311

rawListeners

rawListeners(event): Function[]
Parameters
- event: "error" | "open" | "close" | WikimediaEventStream
Returns Function[]
- Defined in src/WikimediaStream.ts:281

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: "error" | "open" | "close" | WikimediaEventStream
Returns this
- Defined in src/WikimediaStream.ts:273

removeListener

removeListener<T>(event, listener): this
Type Parameters
- T extends keyof WikimediaEventStreamEventTypes
Parameters
- event: T
- listener: WikimediaStreamEventListener<T>
Returns this
- Defined in src/WikimediaStream.ts:264
removeListener(event, listener): this
Parameters
- event: "open" | "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
- Defined in src/WikimediaStream.ts:269
removeListener(event, listener): this
Parameters
- event: "error"
- listener: ((error) => void)
  - - (error): void
    - Parameters
      error: ErrorEvent
      Returns void
Returns this
- Defined in src/WikimediaStream.ts:271

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
- Defined in node_modules/@types/node/events.d.ts:63

waitUntilClosed

waitUntilClosed(): Promise<void>
Returns a promise that resolves when the stream is closed.

Returns Promise<void>
- Defined in src/WikimediaStream.ts:660

`Static` isSpecificWikimediaStream

isSpecificWikimediaStream(stream): stream is "eventgate-main.test.event" | "mediawiki.page-create" | "mediawiki.page-delete" | "mediawiki.page-links-change" | "mediawiki.page-move" | "mediawiki.page-properties-change" | "mediawiki.page-undelete" | "mediawiki.recentchange" | "mediawiki.revision-create" | "mediawiki.revision-tags-change" | "mediawiki.revision-visibility-change"
Checks if a given string is a valid SpecificWikimediaEventStream ID.
Parameters
- stream: WikimediaEventStream
  The string to check.
Returns stream is "eventgate-main.test.event" | "mediawiki.page-create" | "mediawiki.page-delete" | "mediawiki.page-links-change" | "mediawiki.page-move" | "mediawiki.page-properties-change" | "mediawiki.page-undelete" | "mediawiki.recentchange" | "mediawiki.revision-create" | "mediawiki.revision-tags-change" | "mediawiki.revision-visibility-change"
- Defined in src/WikimediaStream.ts:413

`Static` isWikimediaStream

isWikimediaStream(stream): stream is "eventgate-main.test.event" | "mediawiki.page-create" | "mediawiki.page-delete" | "mediawiki.page-links-change" | "mediawiki.page-move" | "mediawiki.page-properties-change" | "mediawiki.page-undelete" | "mediawiki.recentchange" | "mediawiki.revision-create" | "mediawiki.revision-tags-change" | "mediawiki.revision-visibility-change"
Checks if a given string is a valid WikimediaEventStream.
Parameters
- stream: string
  The string to check.
Returns stream is "eventgate-main.test.event" | "mediawiki.page-create" | "mediawiki.page-delete" | "mediawiki.page-links-change" | "mediawiki.page-move" | "mediawiki.page-properties-change" | "mediawiki.page-undelete" | "mediawiki.recentchange" | "mediawiki.revision-create" | "mediawiki.revision-tags-change" | "mediawiki.revision-visibility-change"
Whether the stream is a valid Wikimedia stream ID or not.
- Defined in src/WikimediaStream.ts:390

`Static` isWikimediaStreamAlias

isWikimediaStreamAlias(stream): stream is "page-create" | "page-delete" | "page-links-change" | "page-move" | "page-properties-change" | "page-undelete" | "recentchange" | "revision-create" | "test"
Checks if a given string is a valid AliasWikimediaEventStream ID.
Parameters
- stream: WikimediaEventStream
  The string to check.
Returns stream is "page-create" | "page-delete" | "page-links-change" | "page-move" | "page-properties-change" | "page-undelete" | "recentchange" | "revision-create" | "test"
- Defined in src/WikimediaStream.ts:402

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:22

Class WikimediaStream

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WikimediaStream

Properties

Private _lastEventId

eventSource

Private openCheckInterval

Private restartInterval

Private Readonly startingOptions

Private Readonly streams

Static Readonly VERSION

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static defaultUserAgent

Static Readonly errorMonitor

Static Readonly genericUserAgent

Accessors

lastEventId

Returns WikimediaStreamLastEventID[]

status

Returns EventSourceState

Methods

addListener

Type Parameters

Parameters

Returns this

Parameters

Returns void

Returns this

Parameters

Parameters

Returns void

Returns this

attachEventListeners

Parameters

Returns void

close

Returns void

emit

Type Parameters

Parameters

Returns boolean

Parameters

Returns this

Parameters

Returns this

eventNames

Returns ("error" | "open" | "close" | WikimediaEventStream)[]

filter

Type Parameters

Parameters

Returns WikimediaStreamFilter<WikimediaEventStreamEventTypes[T], T>

getMaxListeners

Returns number

listenerCount

Parameters

Returns number

listeners

Parameters

Returns Function[]

off

Type Parameters

Parameters

Returns this

Parameters

Returns void

Returns this

Parameters

Parameters

Returns void

Returns this

`Private` _lastEventId

`Private` openCheckInterval

`Private` restartInterval

`Private` `Readonly` startingOptions

`Private` `Readonly` streams

`Static` `Readonly` VERSION

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` defaultUserAgent

`Static` `Readonly` errorMonitor

`Static` `Readonly` genericUserAgent

`Static` isSpecificWikimediaStream