EventStream | mstdn-api

WritableStream for Server-sent Events

This implementation is partially adapted from webkit

Hierarchy

Writable
- EventStream

Implements

WritableStream

Index

Constructors

constructor

Properties

Constructors

constructor

new EventStream(opts?: WritableOptions): EventStream

Inherited from Writable.__constructor
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5034
Parameters
- Optional opts: WritableOptions
Returns EventStream

Properties

writable

writable: boolean

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

_destroy(err: Error, callback: Function): void

Inherited from Writable._destroy
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5037
Parameters
- err: Error
- callback: Function
Returns void

_final

_final(callback: Function): void

Inherited from Writable._final
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5038
Parameters
- callback: Function
Returns void

_write

_write(chunk: Buffer, _encoding: string, next: function): void

Overrides Writable._write
- Defined in eventstream.ts:15
Parameters
- chunk: Buffer
- _encoding: string
- next: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

addListener

addListener(event: string, listener: function): this
addListener(event: "close", listener: function): this
addListener(event: "drain", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "finish", listener: function): this
addListener(event: "pipe", listener: function): this
addListener(event: "unpipe", listener: function): this

Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5059
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5060
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5061
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5062
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5063
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5064
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.addListener

Overrides EventEmitter.addListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5065
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this

cork

cork(): void

Inherited from Writable.cork
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5045
Returns void

destroy

destroy(error?: Error): void

Inherited from Writable.destroy
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5047
Parameters
- Optional error: Error
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean
emit(event: "close"): boolean
emit(event: "drain", chunk: Buffer | string): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "pipe", src: Readable): boolean
emit(event: "unpipe", src: Readable): boolean

Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5067
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5068
Parameters
- event: "close"
Returns boolean
Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5069
Parameters
- event: "drain"
- chunk: Buffer | string
Returns boolean
Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5070
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5071
Parameters
- event: "finish"
Returns boolean
Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5072
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Inherited from Writable.emit

Overrides EventEmitter.emit
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5073
Parameters
- event: "unpipe"
- src: Readable
Returns boolean

end

end(): void
end(chunk: any, cb?: Function): void
end(chunk: any, encoding?: undefined | string, cb?: Function): void

Inherited from Writable.end
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5042
Returns void
Inherited from Writable.end
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5043
Parameters
- chunk: any
- Optional cb: Function
Returns void
Inherited from Writable.end
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5044
Parameters
- chunk: any
- Optional encoding: undefined | string
- Optional cb: Function
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:765
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:762
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:766
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:763
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string, listener: function): this
on(event: "close", listener: function): this
on(event: "drain", listener: function): this
on(event: "error", listener: function): this
on(event: "finish", listener: function): this
on(event: "pipe", listener: function): this
on(event: "unpipe", listener: function): this

Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5075
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5076
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5077
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5078
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5079
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5080
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.on

Overrides EventEmitter.on
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5081
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this

once

once(event: string, listener: function): this
once(event: "close", listener: function): this
once(event: "drain", listener: function): this
once(event: "error", listener: function): this
once(event: "finish", listener: function): this
once(event: "pipe", listener: function): this
once(event: "unpipe", listener: function): this

Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5083
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5084
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5085
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5086
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5087
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5088
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.once

Overrides EventEmitter.once
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5089
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this

pipe

pipe<T>(destination: T, options?: undefined | object): T

Inherited from internal.pipe
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:4934
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: undefined | object
Returns T

prependListener

prependListener(event: string, listener: function): this
prependListener(event: "close", listener: function): this
prependListener(event: "drain", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "finish", listener: function): this
prependListener(event: "pipe", listener: function): this
prependListener(event: "unpipe", listener: function): this

Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5091
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5092
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5093
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5094
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5095
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5096
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5097
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string, listener: function): this
prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "drain", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "finish", listener: function): this
prependOnceListener(event: "pipe", listener: function): this
prependOnceListener(event: "unpipe", listener: function): this

Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5099
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5100
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5101
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5102
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5103
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5104
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5105
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:760
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string, listener: function): this
removeListener(event: "close", listener: function): this
removeListener(event: "drain", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: "finish", listener: function): this
removeListener(event: "pipe", listener: function): this
removeListener(event: "unpipe", listener: function): this

Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5107
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5108
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5109
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5110
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5111
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5112
Parameters
- event: "pipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Writable.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5113
Parameters
- event: "unpipe"
- listener: function
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: string): this

Inherited from Writable.setDefaultEncoding
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5041
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:761
Parameters
- n: number
Returns this

uncork

uncork(): void

Inherited from Writable.uncork
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5046
Returns void

write

write(chunk: any, cb?: Function): boolean
write(chunk: any, encoding?: undefined | string, cb?: Function): boolean

Inherited from Writable.write
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5039
Parameters
- chunk: any
- Optional cb: Function
Returns boolean
Inherited from Writable.write
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:5040
Parameters
- chunk: any
- Optional encoding: undefined | string
- Optional cb: Function
Returns boolean

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in C:/node/npm_library/mstdn/node_modules/@types/node/index.d.ts:751
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: WritableOptions

Returns EventStream

Properties

writable

Static defaultMaxListeners

Methods

_destroy

Parameters

err: Error

callback: Function

Returns void

_final

Parameters

callback: Function

Returns void

_write

Parameters

chunk: Buffer

_encoding: string

next: function

Parameters

Optional err: Error

Returns void

Returns void

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "drain"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "finish"

listener: function

Returns void

Returns this

Parameters

event: "pipe"

listener: function

Parameters

src: Readable

Returns void

Returns this

Parameters

event: "unpipe"

listener: function

Parameters

src: Readable

Returns void

Returns this

cork

Returns void

destroy