SubscribableStream class
生バイトを使用可能な形式に変換するために と組み合わせてPayloadAssembler
動作する の拡張機能Duplex
。
- Extends
-
Duplex
コンストラクター
Subscribable |
サブスクライブ可能Stream クラスの新しいインスタンスを初期化します。 |
プロパティ
length |
継承されたプロパティ
default |
|
readable | |
readable |
|
readable |
|
readable |
|
writable | |
writable |
|
writable |
メソッド
subscribe((chunk: any) => void) | データを受信したときにストリームをサブスクライブします。 |
継承されたメソッド
コンストラクターの詳細
SubscribableStream(DuplexOptions)
サブスクライブ可能Stream クラスの新しいインスタンスを初期化します。
new SubscribableStream(options?: DuplexOptions)
パラメーター
- options
-
DuplexOptions
DuplexOptions
このストリームを構築するときに使用する 。
プロパティの詳細
length
length: number
プロパティ値
number
継承されたプロパティの詳細
defaultMaxListeners
static defaultMaxListeners: number
プロパティ値
number
継承元 EventEmitter.defaultMaxListeners
readable
readable: boolean
プロパティ値
boolean
継承元 Readable.readable
readableFlowing
readableFlowing: boolean | null
プロパティ値
boolean | null
継承元 Readable.readableFlowing
readableHighWaterMark
readableHighWaterMark: number
プロパティ値
number
継承元 Readable.readableHighWaterMark
readableLength
readableLength: number
プロパティ値
number
継承元 Readable.readableLength
writable
writable: boolean
プロパティ値
boolean
継承元 Duplex.writable
writableHighWaterMark
writableHighWaterMark: number
プロパティ値
number
継承元 Duplex.writableHighWaterMark
writableLength
writableLength: number
プロパティ値
number
継承元 Duplex.writableLength
メソッドの詳細
subscribe((chunk: any) => void)
データを受信したときにストリームをサブスクライブします。
function subscribe(onData: (chunk: any) => void)
パラメーター
- onData
-
(chunk: any) => void
onData の実行時に呼び出されるコールバック。
継承済みメソッドの詳細
addListener("close", () => void)
イベント エミッタ: 次のようなドキュメントに対して定義されたイベント。
- 閉じる
- [データ]
- end
- 読み やすい
- error
function addListener(event: "close", listener: () => void): this
パラメーター
- event
-
"close"
- listener
-
() => void
戻り値
this
継承元 Readable.addListener
addListener("data", (chunk: any) => void)
function addListener(event: "data", listener: (chunk: any) => void): this
パラメーター
- event
-
"data"
- listener
-
(chunk: any) => void
戻り値
this
継承元 Readable.addListener
addListener("end", () => void)
function addListener(event: "end", listener: () => void): this
パラメーター
- event
-
"end"
- listener
-
() => void
戻り値
this
継承元 Readable.addListener
addListener("error", (err: Error) => void)
function addListener(event: "error", listener: (err: Error) => void): this
パラメーター
- event
-
"error"
- listener
-
(err: Error) => void
戻り値
this
継承元 Readable.addListener
addListener("readable", () => void)
function addListener(event: "readable", listener: () => void): this
パラメーター
- event
-
"readable"
- listener
-
() => void
戻り値
this
継承元 Readable.addListener
addListener(string | symbol, (args: any[]) => void)
function addListener(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 Readable.addListener
cork()
function cork()
継承元 Duplex.cor
destroy(Error)
function destroy(error?: Error)
パラメーター
- error
-
Error
継承元 Readable.destroy
emit("close")
function emit(event: "close"): boolean
パラメーター
- event
-
"close"
戻り値
boolean
継承元 Readable.emit
emit("data", any)
function emit(event: "data", chunk: any): boolean
パラメーター
- event
-
"data"
- chunk
-
any
戻り値
boolean
継承元 Readable.emit
emit("end")
function emit(event: "end"): boolean
パラメーター
- event
-
"end"
戻り値
boolean
継承元 Readable.emit
emit("error", Error)
function emit(event: "error", err: Error): boolean
パラメーター
- event
-
"error"
- err
-
Error
戻り値
boolean
継承元 Readable.emit
emit("readable")
function emit(event: "readable"): boolean
パラメーター
- event
-
"readable"
戻り値
boolean
継承元 Readable.emit
emit(string | symbol, any[])
function emit(event: string | symbol, args: any[]): boolean
パラメーター
- event
-
string | symbol
- args
-
any[]
戻り値
boolean
継承元 Readable.emit
end(() => void)
function end(cb?: () => void)
パラメーター
- cb
-
() => void
継承元 Duplex.end
end(any, () => void)
function end(chunk: any, cb?: () => void)
パラメーター
- chunk
-
any
- cb
-
() => void
継承元 Duplex.end
end(any, string, () => void)
function end(chunk: any, encoding?: string, cb?: () => void)
パラメーター
- chunk
-
any
- encoding
-
string
- cb
-
() => void
継承元 Duplex.end
eventNames()
function eventNames(): Array<string | symbol>
戻り値
Array<string | symbol>
継承元 EventEmitter.eventNames
getMaxListeners()
function getMaxListeners(): number
戻り値
number
継承元 EventEmitter.getMaxListeners
isPaused()
function isPaused(): boolean
戻り値
boolean
継承元 Readable.isPaused
listenerCount(EventEmitter, string | symbol)
警告
この API は非推奨になりました。
since v4.0.0
static function listenerCount(emitter: EventEmitter, event: string | symbol): number
パラメーター
- emitter
-
EventEmitter
- event
-
string | symbol
戻り値
number
継承元 EventEmitter.listenerCount
listenerCount(string | symbol)
function listenerCount(type: string | symbol): number
パラメーター
- type
-
string | symbol
戻り値
number
継承元 EventEmitter.listenerCount
listeners(string | symbol)
function listeners(event: string | symbol): Function[]
パラメーター
- event
-
string | symbol
戻り値
Function[]
継承元 EventEmitter.listeners
off(string | symbol, (args: any[]) => void)
function off(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 EventEmitter.off
on("close", () => void)
function on(event: "close", listener: () => void): this
パラメーター
- event
-
"close"
- listener
-
() => void
戻り値
this
継承元 Readable.on
on("data", (chunk: any) => void)
function on(event: "data", listener: (chunk: any) => void): this
パラメーター
- event
-
"data"
- listener
-
(chunk: any) => void
戻り値
this
継承元 Readable.on
on("end", () => void)
function on(event: "end", listener: () => void): this
パラメーター
- event
-
"end"
- listener
-
() => void
戻り値
this
継承元 Readable.on
on("error", (err: Error) => void)
function on(event: "error", listener: (err: Error) => void): this
パラメーター
- event
-
"error"
- listener
-
(err: Error) => void
戻り値
this
継承元 Readable.on
on("readable", () => void)
function on(event: "readable", listener: () => void): this
パラメーター
- event
-
"readable"
- listener
-
() => void
戻り値
this
継承元 Readable.on
on(string | symbol, (args: any[]) => void)
function on(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 Readable.on
once("close", () => void)
function once(event: "close", listener: () => void): this
パラメーター
- event
-
"close"
- listener
-
() => void
戻り値
this
継承元 Readable.once
once("data", (chunk: any) => void)
function once(event: "data", listener: (chunk: any) => void): this
パラメーター
- event
-
"data"
- listener
-
(chunk: any) => void
戻り値
this
継承元 Readable.once
once("end", () => void)
function once(event: "end", listener: () => void): this
パラメーター
- event
-
"end"
- listener
-
() => void
戻り値
this
継承元 Readable.once
once("error", (err: Error) => void)
function once(event: "error", listener: (err: Error) => void): this
パラメーター
- event
-
"error"
- listener
-
(err: Error) => void
戻り値
this
継承元 Readable.once
once("readable", () => void)
function once(event: "readable", listener: () => void): this
パラメーター
- event
-
"readable"
- listener
-
() => void
戻り値
this
継承元 Readable.once
once(NodeEventTarget, string | symbol)
static function once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
パラメーター
- emitter
-
NodeEventTarget
- event
-
string | symbol
戻り値
Promise<any[]>
継承元 EventEmitter.once
once(string | symbol, (args: any[]) => void)
function once(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 Readable.once
pause()
function pause(): this
戻り値
this
継承元 Readable.pause
pipe<T>(T, { end?: boolean })
function pipe<T>(destination: T, options?: { end?: boolean }): T
パラメーター
- destination
-
T
- options
-
{ end?: boolean }
戻り値
T
internal.pipe から継承
prependListener("close", () => void)
function prependListener(event: "close", listener: () => void): this
パラメーター
- event
-
"close"
- listener
-
() => void
戻り値
this
継承元 Readable.prependListener
prependListener("data", (chunk: any) => void)
function prependListener(event: "data", listener: (chunk: any) => void): this
パラメーター
- event
-
"data"
- listener
-
(chunk: any) => void
戻り値
this
継承元 Readable.prependListener
prependListener("end", () => void)
function prependListener(event: "end", listener: () => void): this
パラメーター
- event
-
"end"
- listener
-
() => void
戻り値
this
継承元 Readable.prependListener
prependListener("error", (err: Error) => void)
function prependListener(event: "error", listener: (err: Error) => void): this
パラメーター
- event
-
"error"
- listener
-
(err: Error) => void
戻り値
this
継承元 Readable.prependListener
prependListener("readable", () => void)
function prependListener(event: "readable", listener: () => void): this
パラメーター
- event
-
"readable"
- listener
-
() => void
戻り値
this
継承元 Readable.prependListener
prependListener(string | symbol, (args: any[]) => void)
function prependListener(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 Readable.prependListener
prependOnceListener("close", () => void)
function prependOnceListener(event: "close", listener: () => void): this
パラメーター
- event
-
"close"
- listener
-
() => void
戻り値
this
継承元 Readable.prependOnceListener
prependOnceListener("data", (chunk: any) => void)
function prependOnceListener(event: "data", listener: (chunk: any) => void): this
パラメーター
- event
-
"data"
- listener
-
(chunk: any) => void
戻り値
this
継承元 Readable.prependOnceListener
prependOnceListener("end", () => void)
function prependOnceListener(event: "end", listener: () => void): this
パラメーター
- event
-
"end"
- listener
-
() => void
戻り値
this
継承元 Readable.prependOnceListener
prependOnceListener("error", (err: Error) => void)
function prependOnceListener(event: "error", listener: (err: Error) => void): this
パラメーター
- event
-
"error"
- listener
-
(err: Error) => void
戻り値
this
継承元 Readable.prependOnceListener
prependOnceListener("readable", () => void)
function prependOnceListener(event: "readable", listener: () => void): this
パラメーター
- event
-
"readable"
- listener
-
() => void
戻り値
this
継承元 Readable.prependOnceListener
prependOnceListener(string | symbol, (args: any[]) => void)
function prependOnceListener(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 Readable.prependOnceListener
push(any, string)
function push(chunk: any, encoding?: string): boolean
パラメーター
- chunk
-
any
- encoding
-
string
戻り値
boolean
継承元 Readable.push
rawListeners(string | symbol)
function rawListeners(event: string | symbol): Function[]
パラメーター
- event
-
string | symbol
戻り値
Function[]
継承元 EventEmitter.rawListeners
read(number)
function read(size?: number): any
パラメーター
- size
-
number
戻り値
any
継承元 Readable.read
removeAllListeners(string | symbol)
function removeAllListeners(event?: string | symbol): this
パラメーター
- event
-
string | symbol
戻り値
this
継承元 EventEmitter.removeAllListeners
removeListener("close", () => void)
function removeListener(event: "close", listener: () => void): this
パラメーター
- event
-
"close"
- listener
-
() => void
戻り値
this
継承元 Readable.removeListener
removeListener("data", (chunk: any) => void)
function removeListener(event: "data", listener: (chunk: any) => void): this
パラメーター
- event
-
"data"
- listener
-
(chunk: any) => void
戻り値
this
継承元 Readable.removeListener
removeListener("end", () => void)
function removeListener(event: "end", listener: () => void): this
パラメーター
- event
-
"end"
- listener
-
() => void
戻り値
this
継承元 Readable.removeListener
removeListener("error", (err: Error) => void)
function removeListener(event: "error", listener: (err: Error) => void): this
パラメーター
- event
-
"error"
- listener
-
(err: Error) => void
戻り値
this
継承元 Readable.removeListener
removeListener("readable", () => void)
function removeListener(event: "readable", listener: () => void): this
パラメーター
- event
-
"readable"
- listener
-
() => void
戻り値
this
継承元 Readable.removeListener
removeListener(string | symbol, (args: any[]) => void)
function removeListener(event: string | symbol, listener: (args: any[]) => void): this
パラメーター
- event
-
string | symbol
- listener
-
(args: any[]) => void
戻り値
this
継承元 Readable.removeListener
resume()
function resume(): this
戻り値
this
継承元 Readable.resume
setDefaultEncoding(string)
function setDefaultEncoding(encoding: string): this
パラメーター
- encoding
-
string
戻り値
this
継承元 Duplex.setDefaultEncoding
setEncoding(string)
function setEncoding(encoding: string): this
パラメーター
- encoding
-
string
戻り値
this
継承元 Readable.setEncoding
setMaxListeners(number)
function setMaxListeners(n: number): this
パラメーター
- n
-
number
戻り値
this
継承元 EventEmitter.setMaxListeners
uncork()
function uncork()
継承元 Duplex.uncork
unpipe(WritableStream)
function unpipe(destination?: WritableStream): this
パラメーター
- destination
-
WritableStream
戻り値
this
継承元 Readable.unpipe
unshift(any)
function unshift(chunk: any)
パラメーター
- chunk
-
any
継承元 Readable.unshift
wrap(ReadableStream)
function wrap(oldStream: ReadableStream): this
パラメーター
- oldStream
-
ReadableStream
戻り値
this
継承元 Readable.wrap
write(any, (error: Error | null | undefined) => void)
function write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean
パラメーター
- chunk
-
any
- cb
-
(error: Error | null | undefined) => void
戻り値
boolean
継承元 Duplex.write
write(any, string, (error: Error | null | undefined) => void)
function write(chunk: any, encoding?: string, cb?: (error: Error | null | undefined) => void): boolean
パラメーター
- chunk
-
any
- encoding
-
string
- cb
-
(error: Error | null | undefined) => void
戻り値
boolean
継承元 Duplex.write