SubscribableStream class

Paket:

botframework-streaming

Eine Erweiterung von Duplex, die in Verbindung mit einem PayloadAssembler, um rohe Bytes in ein Verbrauchsformular zu konvertieren.

Extends

Duplex

Konstruktoren

SubscribableStream(DuplexOptions)

Initialisiert eine neue Instanz der klasse AbonnierenableStream.

Eigenschaften

length

Geerbte Eigenschaften

defaultMaxListeners
readable
readableFlowing
readableHighWaterMark
readableLength
writable
writableHighWaterMark
writableLength

Methoden

subscribe((chunk: any) => void)

Abonniert den Datenstrom, wenn Daten empfangen werden.

Geerbte Methoden

addListener("close", () => void)	Ereignis-Emitter Die definierten Ereignisse für Dokumente, einschließlich: schließen Daten Ende lesenswert Fehler
addListener("data", (chunk: any) => void)
addListener("end", () => void)
addListener("error", (err: Error) => void)
addListener("readable", () => void)
addListener(string | symbol, (args: any[]) => void)
cork()
destroy(Error)
emit("close")
emit("data", any)
emit("end")
emit("error", Error)
emit("readable")
emit(string | symbol, any[])
end(() => void)
end(any, () => void)
end(any, string, () => void)
eventNames()
getMaxListeners()
isPaused()
listenerCount(EventEmitter, string | symbol)
listenerCount(string | symbol)
listeners(string | symbol)
off(string | symbol, (args: any[]) => void)
on("close", () => void)
on("data", (chunk: any) => void)
on("end", () => void)
on("error", (err: Error) => void)
on("readable", () => void)
on(string | symbol, (args: any[]) => void)
once("close", () => void)
once("data", (chunk: any) => void)
once("end", () => void)
once("error", (err: Error) => void)
once("readable", () => void)
once(NodeEventTarget, string | symbol)
once(string | symbol, (args: any[]) => void)
pause()
pipe<T>(T, { end?: boolean })
prependListener("close", () => void)
prependListener("data", (chunk: any) => void)
prependListener("end", () => void)
prependListener("error", (err: Error) => void)
prependListener("readable", () => void)
prependListener(string | symbol, (args: any[]) => void)
prependOnceListener("close", () => void)
prependOnceListener("data", (chunk: any) => void)
prependOnceListener("end", () => void)
prependOnceListener("error", (err: Error) => void)
prependOnceListener("readable", () => void)
prependOnceListener(string | symbol, (args: any[]) => void)
push(any, string)
rawListeners(string | symbol)
read(number)
removeAllListeners(string | symbol)
removeListener("close", () => void)
removeListener("data", (chunk: any) => void)
removeListener("end", () => void)
removeListener("error", (err: Error) => void)
removeListener("readable", () => void)
removeListener(string | symbol, (args: any[]) => void)
resume()
setDefaultEncoding(string)
setEncoding(string)
setMaxListeners(number)
uncork()
unpipe(WritableStream)
unshift(any)
wrap(ReadableStream)
write(any, (error: Error | null | undefined) => void)
write(any, string, (error: Error | null | undefined) => void)

Details zum Konstruktor

SubscribableStream(DuplexOptions)

Initialisiert eine neue Instanz der klasse AbonnierenableStream.

new SubscribableStream(options?: DuplexOptions)

Parameter

options

DuplexOptions

Die DuplexOptions, die beim Erstellen dieses Datenstroms verwendet werden sollen.

Details zur Eigenschaft

length

length: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

defaultMaxListeners

static defaultMaxListeners: number

Eigenschaftswert

number

von EventEmitter.defaultMaxListeners geerbt

readable

readable: boolean

Eigenschaftswert

boolean

geerbt von lesbar.lesbar

readableFlowing

readableFlowing: boolean | null

Eigenschaftswert

boolean | null

geerbt von Readable.readableFlowing

readableHighWaterMark

readableHighWaterMark: number

Eigenschaftswert

number

geerbt von Readable.readableHighWaterMark

readableLength

readableLength: number

Eigenschaftswert

number

geerbt von Readable.lesbarLength

writable

writable: boolean

Eigenschaftswert

boolean

geerbt von Duplex.writable

writableHighWaterMark

writableHighWaterMark: number

Eigenschaftswert

number

geerbt von Duplex.writableHighWaterMark

writableLength

writableLength: number

Eigenschaftswert

number

geerbt von Duplex.writableLength

Details zur Methode

subscribe((chunk: any) => void)

Abonniert den Datenstrom, wenn Daten empfangen werden.

function subscribe(onData: (chunk: any) => void)

Parameter

onData

(chunk: any) => void

Rückruf, der aufgerufen werden soll, wenn onData ausgeführt wird.

Details zur geerbten Methode

addListener("close", () => void)

Ereignis-Emitter Die definierten Ereignisse für Dokumente, einschließlich:

1. schließen
2. Daten
3. Ende
4. lesenswert
5. Fehler

function addListener(event: "close", listener: () => void): this

Parameter

event

"close"

listener

() => void

Gibt zurück

this

Geerbt von Readable.addListener

addListener("data", (chunk: any) => void)

function addListener(event: "data", listener: (chunk: any) => void): this

Parameter

event

"data"

listener

(chunk: any) => void

Gibt zurück

this

Geerbt von Readable.addListener

addListener("end", () => void)

function addListener(event: "end", listener: () => void): this

Parameter

event

"end"

listener

() => void

Gibt zurück

this

Geerbt von Readable.addListener

addListener("error", (err: Error) => void)

function addListener(event: "error", listener: (err: Error) => void): this

Parameter

event

"error"

listener

(err: Error) => void

Gibt zurück

this

Geerbt von Readable.addListener

addListener("readable", () => void)

function addListener(event: "readable", listener: () => void): this

Parameter

event

"readable"

listener

() => void

Gibt zurück

this

Geerbt von Readable.addListener

addListener(string | symbol, (args: any[]) => void)

function addListener(event: string | symbol, listener: (args: any[]) => void): this

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

Geerbt von Readable.addListener

cork()

function cork()

geerbt von Duplex.cork

destroy(Error)

function destroy(error?: Error)

Parameter

error

Error

Geerbt von lesbar.destroy

emit("close")

function emit(event: "close"): boolean

Parameter

event

"close"

Gibt zurück

boolean

geerbt von Readable.emit

emit("data", any)

function emit(event: "data", chunk: any): boolean

Parameter

event

"data"

chunk

any

Gibt zurück

boolean

geerbt von Readable.emit

emit("end")

function emit(event: "end"): boolean

Parameter

event

"end"

Gibt zurück

boolean

geerbt von Readable.emit

emit("error", Error)

function emit(event: "error", err: Error): boolean

Parameter

event

"error"

err

Error

Gibt zurück

boolean

geerbt von Readable.emit

emit("readable")

function emit(event: "readable"): boolean

Parameter

event

"readable"

Gibt zurück

boolean

geerbt von Readable.emit

emit(string | symbol, any[])

function emit(event: string | symbol, args: any[]): boolean

Parameter

event

string | symbol

args

any[]

Gibt zurück

boolean

geerbt von Readable.emit

end(() => void)

function end(cb?: () => void)

Parameter

cb

() => void

geerbt von Duplex.end

end(any, () => void)

function end(chunk: any, cb?: () => void)

Parameter

chunk

any

cb

() => void

geerbt von Duplex.end

end(any, string, () => void)

function end(chunk: any, encoding?: string, cb?: () => void)

Parameter

chunk

any

encoding

string

cb

() => void

geerbt von Duplex.end

eventNames()

function eventNames(): Array<string | symbol>

Gibt zurück

Array<string | symbol>

Geerbt von EventEmitter.eventNames

getMaxListeners()

function getMaxListeners(): number

Gibt zurück

number

Geerbt von EventEmitter.getMaxListeners

isPaused()

function isPaused(): boolean

Gibt zurück

boolean

geerbt von Readable.isPaused

listenerCount(EventEmitter, string | symbol)

Warnung

Diese API ist nun veraltet.

since v4.0.0

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

Parameter

emitter

EventEmitter

event

string | symbol

Gibt zurück

number

geerbt von EventEmitter.listenerCount

listenerCount(string | symbol)

function listenerCount(type: string | symbol): number

Parameter

type

string | symbol

Gibt zurück

number

geerbt von EventEmitter.listenerCount

listeners(string | symbol)

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

Parameter

event

string | symbol

Gibt zurück

Function[]

von EventEmitter.listeners geerbt

off(string | symbol, (args: any[]) => void)

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

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

von EventEmitter.off geerbt

on("close", () => void)

function on(event: "close", listener: () => void): this

Parameter

event

"close"

listener

() => void

Gibt zurück

this

geerbt von Lesbar.on

on("data", (chunk: any) => void)

function on(event: "data", listener: (chunk: any) => void): this

Parameter

event

"data"

listener

(chunk: any) => void

Gibt zurück

this

geerbt von Lesbar.on

on("end", () => void)

function on(event: "end", listener: () => void): this

Parameter

event

"end"

listener

() => void

Gibt zurück

this

geerbt von Lesbar.on

on("error", (err: Error) => void)

function on(event: "error", listener: (err: Error) => void): this

Parameter

event

"error"

listener

(err: Error) => void

Gibt zurück

this

geerbt von Lesbar.on

on("readable", () => void)

function on(event: "readable", listener: () => void): this

Parameter

event

"readable"

listener

() => void

Gibt zurück

this

geerbt von Lesbar.on

on(string | symbol, (args: any[]) => void)

function on(event: string | symbol, listener: (args: any[]) => void): this

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

geerbt von Lesbar.on

once("close", () => void)

function once(event: "close", listener: () => void): this

Parameter

event

"close"

listener

() => void

Gibt zurück

this

geerbt von lesbar.once

once("data", (chunk: any) => void)

function once(event: "data", listener: (chunk: any) => void): this

Parameter

event

"data"

listener

(chunk: any) => void

Gibt zurück

this

geerbt von lesbar.once

once("end", () => void)

function once(event: "end", listener: () => void): this

Parameter

event

"end"

listener

() => void

Gibt zurück

this

geerbt von lesbar.once

once("error", (err: Error) => void)

function once(event: "error", listener: (err: Error) => void): this

Parameter

event

"error"

listener

(err: Error) => void

Gibt zurück

this

geerbt von lesbar.once

once("readable", () => void)

function once(event: "readable", listener: () => void): this

Parameter

event

"readable"

listener

() => void

Gibt zurück

this

geerbt von lesbar.once

once(NodeEventTarget, string | symbol)

static function once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>

Parameter

emitter

NodeEventTarget

event

string | symbol

Gibt zurück

Promise<any[]>

von EventEmitter geerbt.once

once(string | symbol, (args: any[]) => void)

function once(event: string | symbol, listener: (args: any[]) => void): this

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

geerbt von lesbar.once

pause()

function pause(): this

Gibt zurück

this

geerbt von "Lesbar.pause"

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

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

Parameter

destination

T

options

{ end?: boolean }

Gibt zurück

T

von internal.pipe geerbt

prependListener("close", () => void)

function prependListener(event: "close", listener: () => void): this

Parameter

event

"close"

listener

() => void

Gibt zurück

this

geerbt von Readable.prependListener

prependListener("data", (chunk: any) => void)

function prependListener(event: "data", listener: (chunk: any) => void): this

Parameter

event

"data"

listener

(chunk: any) => void

Gibt zurück

this

geerbt von Readable.prependListener

prependListener("end", () => void)

function prependListener(event: "end", listener: () => void): this

Parameter

event

"end"

listener

() => void

Gibt zurück

this

geerbt von Readable.prependListener

prependListener("error", (err: Error) => void)

function prependListener(event: "error", listener: (err: Error) => void): this

Parameter

event

"error"

listener

(err: Error) => void

Gibt zurück

this

geerbt von Readable.prependListener

prependListener("readable", () => void)

function prependListener(event: "readable", listener: () => void): this

Parameter

event

"readable"

listener

() => void

Gibt zurück

this

geerbt von Readable.prependListener

prependListener(string | symbol, (args: any[]) => void)

function prependListener(event: string | symbol, listener: (args: any[]) => void): this

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

geerbt von Readable.prependListener

prependOnceListener("close", () => void)

function prependOnceListener(event: "close", listener: () => void): this

Parameter

event

"close"

listener

() => void

Gibt zurück

this

geerbt von Readable.prependOnceListener

prependOnceListener("data", (chunk: any) => void)

function prependOnceListener(event: "data", listener: (chunk: any) => void): this

Parameter

event

"data"

listener

(chunk: any) => void

Gibt zurück

this

geerbt von Readable.prependOnceListener

prependOnceListener("end", () => void)

function prependOnceListener(event: "end", listener: () => void): this

Parameter

event

"end"

listener

() => void

Gibt zurück

this

geerbt von Readable.prependOnceListener

prependOnceListener("error", (err: Error) => void)

function prependOnceListener(event: "error", listener: (err: Error) => void): this

Parameter

event

"error"

listener

(err: Error) => void

Gibt zurück

this

geerbt von Readable.prependOnceListener

prependOnceListener("readable", () => void)

function prependOnceListener(event: "readable", listener: () => void): this

Parameter

event

"readable"

listener

() => void

Gibt zurück

this

geerbt von Readable.prependOnceListener

prependOnceListener(string | symbol, (args: any[]) => void)

function prependOnceListener(event: string | symbol, listener: (args: any[]) => void): this

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

geerbt von Readable.prependOnceListener

push(any, string)

function push(chunk: any, encoding?: string): boolean

Parameter

chunk

any

encoding

string

Gibt zurück

boolean

geerbt von Readable.push

rawListeners(string | symbol)

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

Parameter

event

string | symbol

Gibt zurück

Function[]

von EventEmitter.rawListeners geerbt

read(number)

function read(size?: number): any

Parameter

size

number

Gibt zurück

any

geerbt von Readable.read

removeAllListeners(string | symbol)

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

Parameter

event

string | symbol

Gibt zurück

this

geerbt von EventEmitter.removeAllListeners

removeListener("close", () => void)

function removeListener(event: "close", listener: () => void): this

Parameter

event

"close"

listener

() => void

Gibt zurück

this

geerbt von Readable.removeListener

removeListener("data", (chunk: any) => void)

function removeListener(event: "data", listener: (chunk: any) => void): this

Parameter

event

"data"

listener

(chunk: any) => void

Gibt zurück

this

geerbt von Readable.removeListener

removeListener("end", () => void)

function removeListener(event: "end", listener: () => void): this

Parameter

event

"end"

listener

() => void

Gibt zurück

this

geerbt von Readable.removeListener

removeListener("error", (err: Error) => void)

function removeListener(event: "error", listener: (err: Error) => void): this

Parameter

event

"error"

listener

(err: Error) => void

Gibt zurück

this

geerbt von Readable.removeListener

removeListener("readable", () => void)

function removeListener(event: "readable", listener: () => void): this

Parameter

event

"readable"

listener

() => void

Gibt zurück

this

geerbt von Readable.removeListener

removeListener(string | symbol, (args: any[]) => void)

function removeListener(event: string | symbol, listener: (args: any[]) => void): this

Parameter

event

string | symbol

listener

(args: any[]) => void

Gibt zurück

this

geerbt von Readable.removeListener

resume()

function resume(): this

Gibt zurück

this

geerbt von Readable.resume

setDefaultEncoding(string)

function setDefaultEncoding(encoding: string): this

Parameter

encoding

string

Gibt zurück

this

Geerbt von Duplex.setDefaultEncoding

setEncoding(string)

function setEncoding(encoding: string): this

Parameter

encoding

string

Gibt zurück

this

geerbt von Readable.setEncoding

setMaxListeners(number)

function setMaxListeners(n: number): this

Parameter

n

number

Gibt zurück

this

Geerbt von EventEmitter.setMaxListeners

uncork()

function uncork()

geerbt von Duplex.uncork

unpipe(WritableStream)

function unpipe(destination?: WritableStream): this

Parameter

destination

WritableStream

Gibt zurück

this

geerbt von Readable.unpipe

unshift(any)

function unshift(chunk: any)

Parameter

chunk

any

Geerbt von Readable.unshift

wrap(ReadableStream)

function wrap(oldStream: ReadableStream): this

Parameter

oldStream

ReadableStream

Gibt zurück

this

geerbt von Readable.wrap

write(any, (error: Error | null | undefined) => void)

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

Parameter

chunk

any

cb

(error: Error | null | undefined) => void

Gibt zurück

boolean

Geerbt von Duplex.write

write(any, string, (error: Error | null | undefined) => void)

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

Parameter

chunk

any

encoding

string

cb

(error: Error | null | undefined) => void

Gibt zurück

boolean

Geerbt von Duplex.write