Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SseStream

Adapted from https://raw.githubusercontent.com/EventSource/node-ssestream Transforms "messages" to W3C event stream content. See https://html.spec.whatwg.org/multipage/server-sent-events.html A message is an object with one or more of the following properties:

  • data (String or object, which gets turned into JSON)
  • type
  • id
  • retry

If constructed with a HTTP Request, it will optimise the socket for streaming. If this stream is piped to an HTTP Response, it will set appropriate headers.

Hierarchy

  • Transform
    • SseStream

Implements

  • ReadableStream
  • Writable

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SseStream(req?: IncomingMessage): SseStream

Properties

destroyed

destroyed: boolean

Private lastEventId

lastEventId: number = null

readable

readable: boolean

Readonly readableEncoding

readableEncoding: BufferEncoding | null

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean | null

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Methods

[Symbol.asyncIterator]

  • [Symbol.asyncIterator](): AsyncIterableIterator<any>

_destroy

  • _destroy(error: Error | null, callback: (error: Error | null) => void): void

  • Parameters

    • error: Error | null
    • callback: (error: Error | null) => void
        • (error: Error | null): void

        • Parameters

          Returns void

    Returns void

_final

  • _final(callback: (error?: Error | null) => void): void

  • Parameters

    • callback: (error?: Error | null) => void
        • (error?: Error | null): void

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

_flush

  • _flush(callback: TransformCallback): void

  • Parameters

    • callback: TransformCallback

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_transform

  • _transform(message: MessageEvent, encoding: string, callback: (error?: Error | null, data?: any) => void): void

  • Parameters

    • message: MessageEvent
    • encoding: string
    • callback: (error?: Error | null, data?: any) => void
        • (error?: Error | null, data?: any): void

        • Parameters

          • Optional error: Error | null
          • Optional data: any

          Returns void

    Returns void

_write

  • _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: (error?: Error | null) => void
        • (error?: Error | null): void

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

Optional _writev

  • _writev(chunks: Array<{ chunk: any; encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void

  • Parameters

    • chunks: Array<{ chunk: any; encoding: BufferEncoding }>
    • callback: (error?: Error | null) => void
        • (error?: Error | null): void

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

addListener

  • addListener(event: "close", listener: () => void): this
  • addListener(event: "data", listener: (chunk: any) => void): this
  • addListener(event: "end", listener: () => void): this
  • addListener(event: "error", listener: (err: Error) => void): this
  • addListener(event: "pause", listener: () => void): this
  • addListener(event: "readable", listener: () => void): this
  • addListener(event: "resume", listener: () => void): this
  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. data
    3. end
    4. error
    5. pause
    6. readable
    7. resume

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

cork

  • cork(): void

  • Returns void

destroy

  • destroy(error?: Error): void

  • Parameters

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): void
  • end(chunk: any, cb?: () => void): void
  • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void

  • Parameters

    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean

  • Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "close", listener: () => void): this
  • on(event: "data", listener: (chunk: any) => void): this
  • on(event: "end", listener: () => void): this
  • on(event: "error", listener: (err: Error) => void): this
  • on(event: "pause", listener: () => void): this
  • on(event: "readable", listener: () => void): this
  • on(event: "resume", listener: () => void): this
  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: "close", listener: () => void): this
  • once(event: "data", listener: (chunk: any) => void): this
  • once(event: "end", listener: () => void): this
  • once(event: "error", listener: (err: Error) => void): this
  • once(event: "pause", listener: () => void): this
  • once(event: "readable", listener: () => void): this
  • once(event: "resume", listener: () => void): this
  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

pause

  • pause(): this

  • Returns this

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

prependListener

  • prependListener(event: "close", listener: () => void): this
  • prependListener(event: "data", listener: (chunk: any) => void): this
  • prependListener(event: "end", listener: () => void): this
  • prependListener(event: "error", listener: (err: Error) => void): this
  • prependListener(event: "pause", listener: () => void): this
  • prependListener(event: "readable", listener: () => void): this
  • prependListener(event: "resume", listener: () => void): this
  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: "close", listener: () => void): this
  • prependOnceListener(event: "data", listener: (chunk: any) => void): this
  • prependOnceListener(event: "end", listener: () => void): this
  • prependOnceListener(event: "error", listener: (err: Error) => void): this
  • prependOnceListener(event: "pause", listener: () => void): this
  • prependOnceListener(event: "readable", listener: () => void): this
  • prependOnceListener(event: "resume", listener: () => void): this
  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

push

  • push(chunk: any, encoding?: BufferEncoding): boolean

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns boolean

rawListeners

  • rawListeners(event: string | symbol): Function[]

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: "close", listener: () => void): this
  • removeListener(event: "data", listener: (chunk: any) => void): this
  • removeListener(event: "end", listener: () => void): this
  • removeListener(event: "error", listener: (err: Error) => void): this
  • removeListener(event: "pause", listener: () => void): this
  • removeListener(event: "readable", listener: () => void): this
  • removeListener(event: "resume", listener: () => void): this
  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(): this

  • Returns this

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): this

  • Parameters

    • encoding: BufferEncoding

    Returns this

setEncoding

  • setEncoding(encoding: BufferEncoding): this

  • Parameters

    • encoding: BufferEncoding

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

uncork

  • uncork(): void

  • Returns void

unpipe

  • unpipe(destination?: WritableStream): this

  • Parameters

    • Optional destination: WritableStream

    Returns this

unshift

  • unshift(chunk: any, encoding?: BufferEncoding): void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns void

wrap

  • wrap(oldStream: ReadableStream): this

  • Parameters

    • oldStream: ReadableStream

    Returns this

write

  • write(chunk: any, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean
  • write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: (error: Error | null | undefined) => void
        • (error: Error | null | undefined): void

        • Parameters

          • error: Error | null | undefined

          Returns void

    Returns boolean

  • Parameters

    • chunk: any
    • Optional cb: (error: Error | null | undefined) => void
        • (error: Error | null | undefined): void

        • Parameters

          • error: Error | null | undefined

          Returns void

    Returns boolean

writeMessage

  • writeMessage(message: MessageEvent, cb: (error: Error | null | undefined) => void): void

  • Calls .write but handles the drain if needed

    Parameters

    • message: MessageEvent
    • cb: (error: Error | null | undefined) => void
        • (error: Error | null | undefined): void

        • Parameters

          • error: Error | null | undefined

          Returns void

    Returns void

Static from

  • from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable

  • A utility method for creating Readable Streams out of iterators.

    Parameters

    • iterable: Iterable<any> | AsyncIterable<any>
    • Optional options: ReadableOptions

    Returns Readable

Generated using TypeDoc