SubscribableStream class

Pacote:

botframework-streaming

Uma extensão de Duplex que opera em conjunto com uma PayloadAssembler para converter bytes brutos em uma forma consumível.

Extends

Duplex

Construtores

SubscribableStream(DuplexOptions)

Inicializa uma nova instância da classe SubscribableStream.

Propriedades

length

Propriedades herdadas

defaultMaxListeners
readable
readableFlowing
readableHighWaterMark
readableLength
writable
writableHighWaterMark
writableLength

Métodos

subscribe((chunk: any) => void)

Assina o fluxo quando recebe dados.

Métodos herdados

addListener("close", () => void)	Emissor de eventos Os eventos definidos em documentos, incluindo: fechar dados fim legível erro
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)

Detalhes do construtor

SubscribableStream(DuplexOptions)

Inicializa uma nova instância da classe SubscribableStream.

new SubscribableStream(options?: DuplexOptions)

Parâmetros

options

DuplexOptions

O DuplexOptions a ser usado ao construir esse fluxo.

Detalhes da propriedade

length

length: number

Valor da propriedade

number

Detalhes das propriedades herdadas

defaultMaxListeners

static defaultMaxListeners: number

Valor da propriedade

number

herdado de EventEmitter.defaultMaxListeners

readable

readable: boolean

Valor da propriedade

boolean

herdado de readable.readable

readableFlowing

readableFlowing: boolean | null

Valor da propriedade

boolean | null

herdado de Readable.readableFlowing

readableHighWaterMark

readableHighWaterMark: number

Valor da propriedade

number

herdado de Readable.readableHighWaterMark

readableLength

readableLength: number

Valor da propriedade

number

Herdado de Readable.readableLength

writable

writable: boolean

Valor da propriedade

boolean

herdado de Duplex.writable

writableHighWaterMark

writableHighWaterMark: number

Valor da propriedade

number

herdado de Duplex.writableHighWaterMark

writableLength

writableLength: number

Valor da propriedade

number

Herdado de Duplex.writableLength

Detalhes do método

subscribe((chunk: any) => void)

Assina o fluxo quando recebe dados.

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

Parâmetros

onData

(chunk: any) => void

Retorno de chamada a ser chamado quando onData é executado.

Detalhes do método herdado

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

Emissor de eventos Os eventos definidos em documentos, incluindo:

1. fechar
2. dados
3. fim
4. legível
5. erro

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

Parâmetros

event

"close"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.addListener

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

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

Parâmetros

event

"end"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.addListener

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

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

Parâmetros

event

"readable"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.addListener

cork()

function cork()

Herdado de Duplex.cork

destroy(Error)

function destroy(error?: Error)

Parâmetros

error

Error

Herdado de Readable.destroy

emit("close")

function emit(event: "close"): boolean

Parâmetros

event

"close"

Retornos

boolean

Herdado de Readable.emit

emit("data", any)

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

Parâmetros

event

"data"

chunk

any

Retornos

boolean

Herdado de Readable.emit

emit("end")

function emit(event: "end"): boolean

Parâmetros

event

"end"

Retornos

boolean

Herdado de Readable.emit

emit("error", Error)

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

Parâmetros

event

"error"

err

Error

Retornos

boolean

Herdado de Readable.emit

emit("readable")

function emit(event: "readable"): boolean

Parâmetros

event

"readable"

Retornos

boolean

Herdado de Readable.emit

emit(string | symbol, any[])

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

Parâmetros

event

string | symbol

args

any[]

Retornos

boolean

Herdado de Readable.emit

end(() => void)

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

Parâmetros

cb

() => void

Herdado de Duplex.end

end(any, () => void)

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

Parâmetros

chunk

any

cb

() => void

Herdado de Duplex.end

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

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

Parâmetros

chunk

any

encoding

string

cb

() => void

Herdado de Duplex.end

eventNames()

function eventNames(): Array<string | symbol>

Retornos

Array<string | symbol>

Herdado de EventEmitter.eventNames

getMaxListeners()

function getMaxListeners(): number

Retornos

number

herdado de EventEmitter.getMaxListeners

isPaused()

function isPaused(): boolean

Retornos

boolean

Herdado de Readable.isPaused

listenerCount(EventEmitter, string | symbol)

Aviso

Essa API foi preterida.

since v4.0.0

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

Parâmetros

emitter

EventEmitter

event

string | symbol

Retornos

number

Herdado de EventEmitter.listenerCount

listenerCount(string | symbol)

function listenerCount(type: string | symbol): number

Parâmetros

type

string | symbol

Retornos

number

Herdado de EventEmitter.listenerCount

listeners(string | symbol)

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

Parâmetros

event

string | symbol

Retornos

Function[]

Herdado 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

Retornos

this

herdado de EventEmitter.off

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

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

Parâmetros

event

"close"

listener

() => void

Retornos

this

herdado de legível.on

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

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

Parâmetros

event

"data"

listener

(chunk: any) => void

Retornos

this

herdado de legível.on

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

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

Parâmetros

event

"end"

listener

() => void

Retornos

this

herdado de legível.on

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

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

Parâmetros

event

"error"

listener

(err: Error) => void

Retornos

this

herdado de legível.on

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

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

Parâmetros

event

"readable"

listener

() => void

Retornos

this

herdado de legível.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

Retornos

this

herdado de legível.on

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

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

Parâmetros

event

"close"

listener

() => void

Retornos

this

herdado de legível.uma vez

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

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

Parâmetros

event

"data"

listener

(chunk: any) => void

Retornos

this

herdado de legível.uma vez

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

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

Parâmetros

event

"end"

listener

() => void

Retornos

this

herdado de legível.uma vez

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

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

Parâmetros

event

"error"

listener

(err: Error) => void

Retornos

this

herdado de legível.uma vez

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

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

Parâmetros

event

"readable"

listener

() => void

Retornos

this

herdado de legível.uma vez

once(NodeEventTarget, string | symbol)

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

Parâmetros

emitter

NodeEventTarget

event

string | symbol

Retornos

Promise<any[]>

herdado 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

Retornos

this

herdado de legível.uma vez

pause()

function pause(): this

Retornos

this

Herdado de Readable.pause

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

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

Parâmetros

destination

T

options

{ end?: boolean }

Retornos

T

Herdado de internal.pipe

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

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

Parâmetros

event

"close"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.prependListener

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

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

Parâmetros

event

"end"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.prependListener

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

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

Parâmetros

event

"readable"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.prependListener

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

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

Parâmetros

event

"close"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.prependOnceListener

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

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

Parâmetros

event

"end"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.prependOnceListener

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

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

Parâmetros

event

"readable"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.prependOnceListener

push(any, string)

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

Parâmetros

chunk

any

encoding

string

Retornos

boolean

Herdado de Readable.push

rawListeners(string | symbol)

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

Parâmetros

event

string | symbol

Retornos

Function[]

herdado de EventEmitter.rawListeners

read(number)

function read(size?: number): any

Parâmetros

size

number

Retornos

any

Herdado de Readable.read

removeAllListeners(string | symbol)

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

Parâmetros

event

string | symbol

Retornos

this

herdado de EventEmitter.removeAllListeners

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

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

Parâmetros

event

"close"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.removeListener

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

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

Parâmetros

event

"end"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.removeListener

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

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

Parâmetros

event

"readable"

listener

() => void

Retornos

this

Herdado 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

Retornos

this

Herdado de Readable.removeListener

resume()

function resume(): this

Retornos

this

Herdado de Readable.resume

setDefaultEncoding(string)

function setDefaultEncoding(encoding: string): this

Parâmetros

encoding

string

Retornos

this

Herdado de Duplex.setDefaultEncoding

setEncoding(string)

function setEncoding(encoding: string): this

Parâmetros

encoding

string

Retornos

this

Herdado de Readable.setEncoding

setMaxListeners(number)

function setMaxListeners(n: number): this

Parâmetros

n

number

Retornos

this

Herdado de EventEmitter.setMaxListeners

uncork()

function uncork()

Herdado de Duplex.uncork

unpipe(WritableStream)

function unpipe(destination?: WritableStream): this

Parâmetros

destination

WritableStream

Retornos

this

Herdado de Readable.unpipe

unshift(any)

function unshift(chunk: any)

Parâmetros

chunk

any

Herdado de Readable.unshift

wrap(ReadableStream)

function wrap(oldStream: ReadableStream): this

Parâmetros

oldStream

ReadableStream

Retornos

this

Herdado 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

Retornos

boolean

Herdado de Duplex.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

Retornos

boolean

Herdado de Duplex.write