SubscribableStream class

Paquete:

botframework-streaming

Extensión de Duplex que funciona junto con un PayloadAssembler para convertir bytes sin procesar en un formulario consumible.

Extends

Duplex

Constructores

SubscribableStream(DuplexOptions)

Inicializa una nueva instancia de la clase SubscribableStream.

Propiedades

length

Propiedades heredadas

defaultMaxListeners
readable
readableFlowing
readableHighWaterMark
readableLength
writable
writableHighWaterMark
writableLength

Métodos

subscribe((chunk: any) => void)

Se suscribe al flujo cuando recibe datos.

Métodos heredados

addListener("close", () => void)	Emisor de eventos: los eventos definidos en documentos, entre los que se incluyen: cerrar datos fin legible error
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)

Detalles del constructor

SubscribableStream(DuplexOptions)

Inicializa una nueva instancia de la clase SubscribableStream.

new SubscribableStream(options?: DuplexOptions)

Parámetros

options

DuplexOptions

El DuplexOptions que se va a usar al construir esta secuencia.

Detalles de las propiedades

length

length: number

Valor de propiedad

number

Detalles de las propiedades heredadas

defaultMaxListeners

static defaultMaxListeners: number

Valor de propiedad

number

Heredado de EventEmitter.defaultMaxListeners

readable

readable: boolean

Valor de propiedad

boolean

heredado de legible.readable

readableFlowing

readableFlowing: boolean | null

Valor de propiedad

boolean | null

heredado de readable.readableFlowing

readableHighWaterMark

readableHighWaterMark: number

Valor de propiedad

number

heredado de readable.readableHighWaterMark

readableLength

readableLength: number

Valor de propiedad

number

heredado de readable.readableLength

writable

writable: boolean

Valor de propiedad

boolean

Heredado de Dúplex.writable

writableHighWaterMark

writableHighWaterMark: number

Valor de propiedad

number

Heredado de Duplex.writableHighWaterMark

writableLength

writableLength: number

Valor de propiedad

number

Heredado de Duplex.writableLength

Detalles del método

subscribe((chunk: any) => void)

Se suscribe al flujo cuando recibe datos.

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

Parámetros

onData

(chunk: any) => void

Devolución de llamada a la que se va a llamar cuando se ejecuta onData.

Detalles de los métodos heredados

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

Emisor de eventos: los eventos definidos en documentos, entre los que se incluyen:

1. cerrar
2. datos
3. fin
4. legible
5. error

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

Parámetros

event

"close"

listener

() => void

Devoluciones

this

Heredado de Readable.addListener

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

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

Parámetros

event

"data"

listener

(chunk: any) => void

Devoluciones

this

Heredado de Readable.addListener

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

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

Parámetros

event

"end"

listener

() => void

Devoluciones

this

Heredado de Readable.addListener

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

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

Parámetros

event

"error"

listener

(err: Error) => void

Devoluciones

this

Heredado de Readable.addListener

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

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

Parámetros

event

"readable"

listener

() => void

Devoluciones

this

Heredado de Readable.addListener

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

Heredado de Readable.addListener

cork()

function cork()

Heredado de Duplex.cork

destroy(Error)

function destroy(error?: Error)

Parámetros

error

Error

heredado de readable.destroy

emit("close")

function emit(event: "close"): boolean

Parámetros

event

"close"

Devoluciones

boolean

Heredado de Readable.emit

emit("data", any)

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

Parámetros

event

"data"

chunk

any

Devoluciones

boolean

Heredado de Readable.emit

emit("end")

function emit(event: "end"): boolean

Parámetros

event

"end"

Devoluciones

boolean

Heredado de Readable.emit

emit("error", Error)

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

Parámetros

event

"error"

err

Error

Devoluciones

boolean

Heredado de Readable.emit

emit("readable")

function emit(event: "readable"): boolean

Parámetros

event

"readable"

Devoluciones

boolean

Heredado de Readable.emit

emit(string | symbol, any[])

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

Parámetros

event

string | symbol

args

any[]

Devoluciones

boolean

Heredado de Readable.emit

end(() => void)

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

Parámetros

cb

() => void

Heredado de Duplex.end

end(any, () => void)

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

Parámetros

chunk

any

cb

() => void

Heredado de Duplex.end

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

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

Parámetros

chunk

any

encoding

string

cb

() => void

Heredado de Duplex.end

eventNames()

function eventNames(): Array<string | symbol>

Devoluciones

Array<string | symbol>

Heredado de EventEmitter.eventNames

getMaxListeners()

function getMaxListeners(): number

Devoluciones

number

se hereda de EventEmitter.getMaxListeners

isPaused()

function isPaused(): boolean

Devoluciones

boolean

heredado de readable.isPaused

listenerCount(EventEmitter, string | symbol)

Advertencia

Esta API ya está en desuso.

since v4.0.0

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

Parámetros

emitter

EventEmitter

event

string | symbol

Devoluciones

number

Heredado de EventEmitter.listenerCount

listenerCount(string | symbol)

function listenerCount(type: string | symbol): number

Parámetros

type

string | symbol

Devoluciones

number

Heredado de EventEmitter.listenerCount

listeners(string | symbol)

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

Parámetros

event

string | symbol

Devoluciones

Function[]

Heredado de EventEmitter.listeners

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

Heredado de EventEmitter.off

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

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

Parámetros

event

"close"

listener

() => void

Devoluciones

this

heredado de legible.on

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

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

Parámetros

event

"data"

listener

(chunk: any) => void

Devoluciones

this

heredado de legible.on

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

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

Parámetros

event

"end"

listener

() => void

Devoluciones

this

heredado de legible.on

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

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

Parámetros

event

"error"

listener

(err: Error) => void

Devoluciones

this

heredado de legible.on

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

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

Parámetros

event

"readable"

listener

() => void

Devoluciones

this

heredado de legible.on

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

heredado de legible.on

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

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

Parámetros

event

"close"

listener

() => void

Devoluciones

this

se hereda de legible.once

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

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

Parámetros

event

"data"

listener

(chunk: any) => void

Devoluciones

this

se hereda de legible.once

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

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

Parámetros

event

"end"

listener

() => void

Devoluciones

this

se hereda de legible.once

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

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

Parámetros

event

"error"

listener

(err: Error) => void

Devoluciones

this

se hereda de legible.once

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

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

Parámetros

event

"readable"

listener

() => void

Devoluciones

this

se hereda de legible.once

once(NodeEventTarget, string | symbol)

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

Parámetros

emitter

NodeEventTarget

event

string | symbol

Devoluciones

Promise<any[]>

heredado de EventEmitter.once

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

se hereda de legible.once

pause()

function pause(): this

Devoluciones

this

heredado de readable.pause

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

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

Parámetros

destination

T

options

{ end?: boolean }

Devoluciones

T

heredado de internal.pipe

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

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

Parámetros

event

"close"

listener

() => void

Devoluciones

this

heredado de readable.prependListener

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

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

Parámetros

event

"data"

listener

(chunk: any) => void

Devoluciones

this

heredado de readable.prependListener

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

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

Parámetros

event

"end"

listener

() => void

Devoluciones

this

heredado de readable.prependListener

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

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

Parámetros

event

"error"

listener

(err: Error) => void

Devoluciones

this

heredado de readable.prependListener

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

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

Parámetros

event

"readable"

listener

() => void

Devoluciones

this

heredado de readable.prependListener

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

heredado de readable.prependListener

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

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

Parámetros

event

"close"

listener

() => void

Devoluciones

this

heredado de readable.prependOnceListener

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

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

Parámetros

event

"data"

listener

(chunk: any) => void

Devoluciones

this

heredado de readable.prependOnceListener

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

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

Parámetros

event

"end"

listener

() => void

Devoluciones

this

heredado de readable.prependOnceListener

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

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

Parámetros

event

"error"

listener

(err: Error) => void

Devoluciones

this

heredado de readable.prependOnceListener

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

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

Parámetros

event

"readable"

listener

() => void

Devoluciones

this

heredado de readable.prependOnceListener

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

heredado de readable.prependOnceListener

push(any, string)

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

Parámetros

chunk

any

encoding

string

Devoluciones

boolean

heredado de readable.push

rawListeners(string | symbol)

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

Parámetros

event

string | symbol

Devoluciones

Function[]

heredado de EventEmitter.rawListeners

read(number)

function read(size?: number): any

Parámetros

size

number

Devoluciones

any

heredado de readable.read

removeAllListeners(string | symbol)

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

Parámetros

event

string | symbol

Devoluciones

this

Heredado de EventEmitter.removeAllListeners

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

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

Parámetros

event

"close"

listener

() => void

Devoluciones

this

Heredado de Readable.removeListener

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

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

Parámetros

event

"data"

listener

(chunk: any) => void

Devoluciones

this

Heredado de Readable.removeListener

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

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

Parámetros

event

"end"

listener

() => void

Devoluciones

this

Heredado de Readable.removeListener

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

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

Parámetros

event

"error"

listener

(err: Error) => void

Devoluciones

this

Heredado de Readable.removeListener

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

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

Parámetros

event

"readable"

listener

() => void

Devoluciones

this

Heredado de Readable.removeListener

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

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

Parámetros

event

string | symbol

listener

(args: any[]) => void

Devoluciones

this

Heredado de Readable.removeListener

resume()

function resume(): this

Devoluciones

this

heredado de readable.resume

setDefaultEncoding(string)

function setDefaultEncoding(encoding: string): this

Parámetros

encoding

string

Devoluciones

this

Heredado de Duplex.setDefaultEncoding

setEncoding(string)

function setEncoding(encoding: string): this

Parámetros

encoding

string

Devoluciones

this

Heredado de Readable.setEncoding

setMaxListeners(number)

function setMaxListeners(n: number): this

Parámetros

n

number

Devoluciones

this

Heredado de EventEmitter.setMaxListeners

uncork()

function uncork()

Heredado de Duplex.uncork

unpipe(WritableStream)

function unpipe(destination?: WritableStream): this

Parámetros

destination

WritableStream

Devoluciones

this

heredado de readable.unpipe

unshift(any)

function unshift(chunk: any)

Parámetros

chunk

any

heredado de readable.unshift

wrap(ReadableStream)

function wrap(oldStream: ReadableStream): this

Parámetros

oldStream

ReadableStream

Devoluciones

this

heredado de readable.wrap

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

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

Parámetros

chunk

any

cb

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

Devoluciones

boolean

Heredado de Dúplex.write

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

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

Parámetros

chunk

any

encoding

string

cb

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

Devoluciones

boolean

Heredado de Dúplex.write