SubscribableStream class

Pacchetto:

botframework-streaming

Estensione di Duplex che opera insieme a un PayloadAssembler per convertire i byte non elaborati in un formato utilizzabile.

Extends

Duplex

Costruttori

SubscribableStream(DuplexOptions)

Inizializza una nuova istanza della classe Di sottoscrizione.

Proprietà

length

Proprietà ereditate

defaultMaxListeners
readable
readableFlowing
readableHighWaterMark
readableLength
writable
writableHighWaterMark
writableLength

Metodi

subscribe((chunk: any) => void)

Sottoscrive il flusso quando riceve i dati.

Metodi ereditati

addListener("close", () => void)	Emettitore di eventi Gli eventi definiti nei documenti, tra cui: chiudere dati fine leggibile errore
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)

Dettagli costruttore

SubscribableStream(DuplexOptions)

Inizializza una nuova istanza della classe Di sottoscrizione.

new SubscribableStream(options?: DuplexOptions)

Parametri

options

DuplexOptions

Il DuplexOptions da usare durante la costruzione di questo flusso.

Dettagli proprietà

length

length: number

Valore della proprietà

number

Dettagli proprietà ereditate

defaultMaxListeners

static defaultMaxListeners: number

Valore della proprietà

number

Ereditato da EventEmitter.defaultMaxListeners

readable

readable: boolean

Valore della proprietà

boolean

ereditato da leggibile

readableFlowing

readableFlowing: boolean | null

Valore della proprietà

boolean | null

ereditato da Readable.readableFlowing

readableHighWaterMark

readableHighWaterMark: number

Valore della proprietà

number

ereditato da Readable.readableHighWaterMark

readableLength

readableLength: number

Valore della proprietà

number

ereditato da Readable.readableLength

writable

writable: boolean

Valore della proprietà

boolean

ereditato da duplex.scrivibile

writableHighWaterMark

writableHighWaterMark: number

Valore della proprietà

number

ereditato da Duplex.writableHighWaterMark

writableLength

writableLength: number

Valore della proprietà

number

ereditato da duplex.writableLength

Dettagli metodo

subscribe((chunk: any) => void)

Sottoscrive il flusso quando riceve i dati.

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

Parametri

onData

(chunk: any) => void

Callback da chiamare quando viene eseguito onData.

Dettagli dei metodi ereditati

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

Emettitore di eventi Gli eventi definiti nei documenti, tra cui:

1. chiudere
2. dati
3. fine
4. leggibile
5. errore

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

Parametri

event

"close"

listener

() => void

Restituisce

this

Ereditato da Readable.addListener

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

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

Parametri

event

"data"

listener

(chunk: any) => void

Restituisce

this

Ereditato da Readable.addListener

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

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

Parametri

event

"end"

listener

() => void

Restituisce

this

Ereditato da Readable.addListener

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

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

Parametri

event

"error"

listener

(err: Error) => void

Restituisce

this

Ereditato da Readable.addListener

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

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

Parametri

event

"readable"

listener

() => void

Restituisce

this

Ereditato da Readable.addListener

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

Ereditato da Readable.addListener

cork()

function cork()

ereditato da duplex.cork

destroy(Error)

function destroy(error?: Error)

Parametri

error

Error

Ereditato da Readable.destroy

emit("close")

function emit(event: "close"): boolean

Parametri

event

"close"

Restituisce

boolean

Ereditato da Readable.emit

emit("data", any)

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

Parametri

event

"data"

chunk

any

Restituisce

boolean

Ereditato da Readable.emit

emit("end")

function emit(event: "end"): boolean

Parametri

event

"end"

Restituisce

boolean

Ereditato da Readable.emit

emit("error", Error)

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

Parametri

event

"error"

err

Error

Restituisce

boolean

Ereditato da Readable.emit

emit("readable")

function emit(event: "readable"): boolean

Parametri

event

"readable"

Restituisce

boolean

Ereditato da Readable.emit

emit(string | symbol, any[])

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

Parametri

event

string | symbol

args

any[]

Restituisce

boolean

Ereditato da Readable.emit

end(() => void)

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

Parametri

cb

() => void

ereditato da duplex.end

end(any, () => void)

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

Parametri

chunk

any

cb

() => void

ereditato da duplex.end

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

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

Parametri

chunk

any

encoding

string

cb

() => void

ereditato da duplex.end

eventNames()

function eventNames(): Array<string | symbol>

Restituisce

Array<string | symbol>

Ereditato da EventEmitter.eventNames

getMaxListeners()

function getMaxListeners(): number

Restituisce

number

ereditato da EventEmitter.getMaxListeners

isPaused()

function isPaused(): boolean

Restituisce

boolean

ereditato da leggibile.isPaused

listenerCount(EventEmitter, string | symbol)

Avviso

Questa API è ora deprecata.

since v4.0.0

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

Parametri

emitter

EventEmitter

event

string | symbol

Restituisce

number

Ereditato da EventEmitter.listenerCount

listenerCount(string | symbol)

function listenerCount(type: string | symbol): number

Parametri

type

string | symbol

Restituisce

number

Ereditato da EventEmitter.listenerCount

listeners(string | symbol)

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

Parametri

event

string | symbol

Restituisce

Function[]

Ereditato da EventEmitter.listener

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

Ereditato da EventEmitter.off

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

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

Parametri

event

"close"

listener

() => void

Restituisce

this

ereditato da leggibile.on

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

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

Parametri

event

"data"

listener

(chunk: any) => void

Restituisce

this

ereditato da leggibile.on

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

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

Parametri

event

"end"

listener

() => void

Restituisce

this

ereditato da leggibile.on

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

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

Parametri

event

"error"

listener

(err: Error) => void

Restituisce

this

ereditato da leggibile.on

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

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

Parametri

event

"readable"

listener

() => void

Restituisce

this

ereditato da leggibile.on

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

ereditato da leggibile.on

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

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

Parametri

event

"close"

listener

() => void

Restituisce

this

ereditato da leggibile.once

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

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

Parametri

event

"data"

listener

(chunk: any) => void

Restituisce

this

ereditato da leggibile.once

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

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

Parametri

event

"end"

listener

() => void

Restituisce

this

ereditato da leggibile.once

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

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

Parametri

event

"error"

listener

(err: Error) => void

Restituisce

this

ereditato da leggibile.once

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

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

Parametri

event

"readable"

listener

() => void

Restituisce

this

ereditato da leggibile.once

once(NodeEventTarget, string | symbol)

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

Parametri

emitter

NodeEventTarget

event

string | symbol

Restituisce

Promise<any[]>

ereditato da EventEmitter.once

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

ereditato da leggibile.once

pause()

function pause(): this

Restituisce

this

Ereditato da leggibile.pause

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

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

Parametri

destination

T

options

{ end?: boolean }

Restituisce

T

Ereditato da internal.pipe

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

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

Parametri

event

"close"

listener

() => void

Restituisce

this

Ereditato da Readable.prependListener

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

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

Parametri

event

"data"

listener

(chunk: any) => void

Restituisce

this

Ereditato da Readable.prependListener

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

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

Parametri

event

"end"

listener

() => void

Restituisce

this

Ereditato da Readable.prependListener

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

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

Parametri

event

"error"

listener

(err: Error) => void

Restituisce

this

Ereditato da Readable.prependListener

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

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

Parametri

event

"readable"

listener

() => void

Restituisce

this

Ereditato da Readable.prependListener

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

Ereditato da Readable.prependListener

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

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

Parametri

event

"close"

listener

() => void

Restituisce

this

Ereditato da Readable.prependOnceListener

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

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

Parametri

event

"data"

listener

(chunk: any) => void

Restituisce

this

Ereditato da Readable.prependOnceListener

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

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

Parametri

event

"end"

listener

() => void

Restituisce

this

Ereditato da Readable.prependOnceListener

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

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

Parametri

event

"error"

listener

(err: Error) => void

Restituisce

this

Ereditato da Readable.prependOnceListener

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

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

Parametri

event

"readable"

listener

() => void

Restituisce

this

Ereditato da Readable.prependOnceListener

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

Ereditato da Readable.prependOnceListener

push(any, string)

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

Parametri

chunk

any

encoding

string

Restituisce

boolean

Ereditato da Readable.push

rawListeners(string | symbol)

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

Parametri

event

string | symbol

Restituisce

Function[]

ereditato da EventEmitter.rawListeners

read(number)

function read(size?: number): any

Parametri

size

number

Restituisce

any

ereditato da leggibile.read

removeAllListeners(string | symbol)

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

Parametri

event

string | symbol

Restituisce

this

Ereditato da EventEmitter.removeAllListeners

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

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

Parametri

event

"close"

listener

() => void

Restituisce

this

Ereditato da Readable.removeListener

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

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

Parametri

event

"data"

listener

(chunk: any) => void

Restituisce

this

Ereditato da Readable.removeListener

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

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

Parametri

event

"end"

listener

() => void

Restituisce

this

Ereditato da Readable.removeListener

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

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

Parametri

event

"error"

listener

(err: Error) => void

Restituisce

this

Ereditato da Readable.removeListener

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

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

Parametri

event

"readable"

listener

() => void

Restituisce

this

Ereditato da Readable.removeListener

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

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

Parametri

event

string | symbol

listener

(args: any[]) => void

Restituisce

this

Ereditato da Readable.removeListener

resume()

function resume(): this

Restituisce

this

ereditato da Readable.resume

setDefaultEncoding(string)

function setDefaultEncoding(encoding: string): this

Parametri

encoding

string

Restituisce

this

Ereditato da Duplex.setDefaultEncoding

setEncoding(string)

function setEncoding(encoding: string): this

Parametri

encoding

string

Restituisce

this

Ereditato da Readable.setEncoding

setMaxListeners(number)

function setMaxListeners(n: number): this

Parametri

n

number

Restituisce

this

Ereditato da EventEmitter.setMaxListeners

uncork()

function uncork()

ereditato da duplex.uncork

unpipe(WritableStream)

function unpipe(destination?: WritableStream): this

Parametri

destination

WritableStream

Restituisce

this

ereditato da Readable.unpipe

unshift(any)

function unshift(chunk: any)

Parametri

chunk

any

ereditato da Readable.unshift

wrap(ReadableStream)

function wrap(oldStream: ReadableStream): this

Parametri

oldStream

ReadableStream

Restituisce

this

Ereditato da leggibile.

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

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

Parametri

chunk

any

cb

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

Restituisce

boolean

Ereditato da Duplex.write

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

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

Parametri

chunk

any

encoding

string

cb

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

Restituisce

boolean

Ereditato da Duplex.write