Partager via

SubscribableStream class

  • Référence
Paquet:
botframework-streaming

Extension de Duplex qui fonctionne conjointement avec un PayloadAssembler pour convertir des octets bruts en forme consommable.

Extends

Duplex

Constructeurs

SubscribableStream(DuplexOptions)

Initialise une nouvelle instance de la classe SubscribableStream.

Propriétés

length

Propriétés héritées

defaultMaxListeners
readable
readableFlowing
readableHighWaterMark
readableLength
writable
writableHighWaterMark
writableLength

Méthodes

subscribe((chunk: any) => void)

S’abonne au flux lorsqu’il reçoit des données.

Méthodes héritées

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

Émetteur d’événement Les événements définis sur les documents, notamment :

  1. fermer
  2. données
  3. fin
  4. lisible
  5. erreur
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)

Détails du constructeur

SubscribableStream(DuplexOptions)

Initialise une nouvelle instance de la classe SubscribableStream.

new SubscribableStream(options?: DuplexOptions)

Paramètres

options

DuplexOptions

La DuplexOptions à utiliser lors de la construction de ce flux.

Détails de la propriété

length 

length: number

Valeur de propriété

number

Détails de la propriété héritée

defaultMaxListeners 

static defaultMaxListeners: number

Valeur de propriété

number

héritée de EventEmitter.defaultMaxListeners

readable 

readable: boolean

Valeur de propriété

boolean

héritée de readable.readable

readableFlowing 

readableFlowing: boolean | null

Valeur de propriété

boolean | null

héritée de Readable.readableFlowing

readableHighWaterMark 

readableHighWaterMark: number

Valeur de propriété

number

héritée de Readable.readableHighWaterMark

readableLength 

readableLength: number

Valeur de propriété

number

héritée de Readable.readableLength

writable 

writable: boolean

Valeur de propriété

boolean

héritée de Duplex.writable

writableHighWaterMark 

writableHighWaterMark: number

Valeur de propriété

number

héritée de Duplex.writableHighWaterMark

writableLength 

writableLength: number

Valeur de propriété

number

héritée de Duplex.writableLength

Détails de la méthode

subscribe((chunk: any) => void)

S’abonne au flux lorsqu’il reçoit des données.

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

Paramètres

onData

(chunk: any) => void

Rappel à appeler quand onData est exécuté.

Détails de la méthode héritée

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

Émetteur d’événement Les événements définis sur les documents, notamment :

  1. fermer
  2. données
  3. fin
  4. lisible
  5. erreur
function addListener(event: "close", listener: () => void): this

Paramètres

event

"close"

listener

() => void

Retours

this

héritée de Readable.addListener

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

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

Paramètres

event

"data"

listener

(chunk: any) => void

Retours

this

héritée de Readable.addListener

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

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

Paramètres

event

"end"

listener

() => void

Retours

this

héritée de Readable.addListener

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

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

Paramètres

event

"error"

listener

(err: Error) => void

Retours

this

héritée de Readable.addListener

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

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

Paramètres

event

"readable"

listener

() => void

Retours

this

héritée de Readable.addListener

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de Readable.addListener

cork() 

function cork()

héritée de Duplex.cork

destroy(Error) 

function destroy(error?: Error)

Paramètres

error

Error

héritée de Readable.destroy

emit("close") 

function emit(event: "close"): boolean

Paramètres

event

"close"

Retours

boolean

héritée de Readable.emit

emit("data", any) 

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

Paramètres

event

"data"

chunk

any

Retours

boolean

héritée de Readable.emit

emit("end") 

function emit(event: "end"): boolean

Paramètres

event

"end"

Retours

boolean

héritée de Readable.emit

emit("error", Error) 

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

Paramètres

event

"error"

err

Error

Retours

boolean

héritée de Readable.emit

emit("readable") 

function emit(event: "readable"): boolean

Paramètres

event

"readable"

Retours

boolean

héritée de Readable.emit

emit(string | symbol, any[]) 

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

Paramètres

event

string | symbol

args

any[]

Retours

boolean

héritée de Readable.emit

end(() => void) 

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

Paramètres

cb

() => void

héritée de Duplex.end

end(any, () => void) 

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

Paramètres

chunk

any

cb

() => void

héritée de Duplex.end

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

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

Paramètres

chunk

any

encoding

string

cb

() => void

héritée de Duplex.end

eventNames() 

function eventNames(): Array<string | symbol>

Retours

Array<string | symbol>

héritée de EventEmitter.eventNames

getMaxListeners() 

function getMaxListeners(): number

Retours

number

héritée de EventEmitter.getMaxListeners

isPaused() 

function isPaused(): boolean

Retours

boolean

héritée de Readable.isPaused

listenerCount(EventEmitter, string | symbol)

Avertissement

Cette API est à présent déconseillée.

since v4.0.0

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

Paramètres

emitter

EventEmitter

event

string | symbol

Retours

number

héritée de EventEmitter.listenerCount

listenerCount(string | symbol) 

function listenerCount(type: string | symbol): number

Paramètres

type

string | symbol

Retours

number

héritée de EventEmitter.listenerCount

listeners(string | symbol) 

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

Paramètres

event

string | symbol

Retours

Function[]

héritée de EventEmitter.listeners

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de EventEmitter.off

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

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

Paramètres

event

"close"

listener

() => void

Retours

this

héritée de readable.on

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

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

Paramètres

event

"data"

listener

(chunk: any) => void

Retours

this

héritée de readable.on

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

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

Paramètres

event

"end"

listener

() => void

Retours

this

héritée de readable.on

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

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

Paramètres

event

"error"

listener

(err: Error) => void

Retours

this

héritée de readable.on

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

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

Paramètres

event

"readable"

listener

() => void

Retours

this

héritée de readable.on

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de readable.on

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

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

Paramètres

event

"close"

listener

() => void

Retours

this

héritée de readable.once

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

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

Paramètres

event

"data"

listener

(chunk: any) => void

Retours

this

héritée de readable.once

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

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

Paramètres

event

"end"

listener

() => void

Retours

this

héritée de readable.once

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

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

Paramètres

event

"error"

listener

(err: Error) => void

Retours

this

héritée de readable.once

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

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

Paramètres

event

"readable"

listener

() => void

Retours

this

héritée de readable.once

once(NodeEventTarget, string | symbol) 

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

Paramètres

emitter

NodeEventTarget

event

string | symbol

Retours

Promise<any[]>

héritée de EventEmitter.once

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de readable.once

pause() 

function pause(): this

Retours

this

héritée de Readable.pause

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

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

Paramètres

destination

T

options

{ end?: boolean }

Retours

T

héritée de internal.pipe

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

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

Paramètres

event

"close"

listener

() => void

Retours

this

héritée de Readable.prependListener

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

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

Paramètres

event

"data"

listener

(chunk: any) => void

Retours

this

héritée de Readable.prependListener

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

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

Paramètres

event

"end"

listener

() => void

Retours

this

héritée de Readable.prependListener

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

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

Paramètres

event

"error"

listener

(err: Error) => void

Retours

this

héritée de Readable.prependListener

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

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

Paramètres

event

"readable"

listener

() => void

Retours

this

héritée de Readable.prependListener

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de Readable.prependListener

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

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

Paramètres

event

"close"

listener

() => void

Retours

this

héritée de Readable.prependOnceListener

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

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

Paramètres

event

"data"

listener

(chunk: any) => void

Retours

this

héritée de Readable.prependOnceListener

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

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

Paramètres

event

"end"

listener

() => void

Retours

this

héritée de Readable.prependOnceListener

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

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

Paramètres

event

"error"

listener

(err: Error) => void

Retours

this

héritée de Readable.prependOnceListener

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

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

Paramètres

event

"readable"

listener

() => void

Retours

this

héritée de Readable.prependOnceListener

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de Readable.prependOnceListener

push(any, string) 

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

Paramètres

chunk

any

encoding

string

Retours

boolean

héritée de Readable.push

rawListeners(string | symbol) 

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

Paramètres

event

string | symbol

Retours

Function[]

héritée de EventEmitter.rawListeners

read(number) 

function read(size?: number): any

Paramètres

size

number

Retours

any

héritée de readable.read

removeAllListeners(string | symbol) 

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

Paramètres

event

string | symbol

Retours

this

héritée de EventEmitter.removeAllListeners

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

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

Paramètres

event

"close"

listener

() => void

Retours

this

héritée de Readable.removeListener

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

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

Paramètres

event

"data"

listener

(chunk: any) => void

Retours

this

héritée de Readable.removeListener

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

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

Paramètres

event

"end"

listener

() => void

Retours

this

héritée de Readable.removeListener

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

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

Paramètres

event

"error"

listener

(err: Error) => void

Retours

this

héritée de Readable.removeListener

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

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

Paramètres

event

"readable"

listener

() => void

Retours

this

héritée de Readable.removeListener

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

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

Paramètres

event

string | symbol

listener

(args: any[]) => void

Retours

this

héritée de Readable.removeListener

resume() 

function resume(): this

Retours

this

héritée de readable.resume

setDefaultEncoding(string) 

function setDefaultEncoding(encoding: string): this

Paramètres

encoding

string

Retours

this

héritée de Duplex.setDefaultEncoding

setEncoding(string) 

function setEncoding(encoding: string): this

Paramètres

encoding

string

Retours

this

héritée de Readable.setEncoding

setMaxListeners(number) 

function setMaxListeners(n: number): this

Paramètres

n

number

Retours

this

héritée de EventEmitter.setMaxListeners

uncork() 

function uncork()

héritée de Duplex.uncork

unpipe(WritableStream) 

function unpipe(destination?: WritableStream): this

Paramètres

destination

WritableStream

Retours

this

héritée de readable.unpipe

unshift(any) 

function unshift(chunk: any)

Paramètres

chunk

any

héritée de Readable.unshift

wrap(ReadableStream) 

function wrap(oldStream: ReadableStream): this

Paramètres

oldStream

ReadableStream

Retours

this

héritée de Readable.wrap

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

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

Paramètres

chunk

any

cb

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

Retours

boolean

héritée de Duplex.write

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

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

Paramètres

chunk

any

encoding

string

cb

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

Retours

boolean

héritée de Duplex.write