Sink | @nestjs/core

Hierarchy

Writable
- Sink

Implements

WritableStream
WritableStream<this> & WriteHeaders

Index

Constructors

constructor

Properties

Accessors

content

Constructors

constructor

new Sink(writeHead?: (statusCode: number, headers?: OutgoingHttpHeaders | string) => void): Sink

Overrides Writable.__constructor
- Defined in packages/core/test/router/sse-stream.spec.ts:16
Parameters
- Optional writeHead: (statusCode: number, headers?: OutgoingHttpHeaders | string) => void
  - - (statusCode: number, headers?: OutgoingHttpHeaders | string): void
    - Parameters
      - statusCode: number
      - Optional headers: OutgoingHttpHeaders | string
      Returns void
Returns Sink

Properties

Private Readonly chunks

chunks: string[] = []

destroyed

destroyed: boolean

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Optional Readonly writeHead

writeHead: (statusCode: number, headers?: OutgoingHttpHeaders | string) => void

Type declaration

- (statusCode: number, headers?: OutgoingHttpHeaders | string): void
- Parameters
  - statusCode: number
  - Optional headers: OutgoingHttpHeaders | string
  Returns void

Accessors

content

get content(): string

- Defined in packages/core/test/router/sse-stream.spec.ts:36
Returns string

Methods

_destroy

_destroy(error: Error | null, callback: (error?: Error | null) => void): void

Inherited from Sink._destroy
- Defined in node_modules/@types/node/stream.d.ts:152
Parameters
- error: Error | null
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_final

_final(callback: (error?: Error | null) => void): void

Inherited from Sink._final
- Defined in node_modules/@types/node/stream.d.ts:153
Parameters
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_write

_write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void

Overrides Writable._write
- Defined in packages/core/test/router/sse-stream.spec.ts:27
Parameters
- chunk: any
- encoding: string
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<{ chunk: any; encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void

Inherited from Sink._writev
- Defined in node_modules/@types/node/stream.d.ts:151
Parameters
- chunks: Array<{ chunk: any; encoding: BufferEncoding }>
- callback: (error?: Error | null) => void
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "close", listener: () => void): this
addListener(event: "drain", listener: () => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: "finish", listener: () => void): this
addListener(event: "pipe", listener: (src: Readable) => void): this
addListener(event: "unpipe", listener: (src: Readable) => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:174
Event emitter The defined events on documents including:
1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:175
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:176
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:177
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:178
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:179
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/stream.d.ts:180
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

cork

cork(): void

Inherited from Sink.cork
- Defined in node_modules/@types/node/stream.d.ts:160
Returns void

destroy

destroy(error?: Error): void

Inherited from Sink.destroy
- Defined in node_modules/@types/node/stream.d.ts:162
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "drain"): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "pipe", src: Readable): boolean
emit(event: "unpipe", src: Readable): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:182
Parameters
- event: "close"
Returns boolean
Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:183
Parameters
- event: "drain"
Returns boolean
Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:184
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:185
Parameters
- event: "finish"
Returns boolean
Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:186
Parameters
- event: "pipe"
- src: Readable
Returns boolean
Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:187
Parameters
- event: "unpipe"
- src: Readable
Returns boolean
Inherited from Sink.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:188
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

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

Inherited from Sink.end
- Defined in node_modules/@types/node/stream.d.ts:157
Parameters
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void
Inherited from Sink.end
- Defined in node_modules/@types/node/stream.d.ts:158
Parameters
- chunk: any
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void
Inherited from Sink.end
- Defined in node_modules/@types/node/stream.d.ts:159
Parameters
- chunk: any
- encoding: BufferEncoding
- Optional cb: () => void
  - - (): void
    - Returns void
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from SseStream.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from SseStream.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from SseStream.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from SseStream.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from SseStream.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "close", listener: () => void): this
on(event: "drain", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: "finish", listener: () => void): this
on(event: "pipe", listener: (src: Readable) => void): this
on(event: "unpipe", listener: (src: Readable) => void): this
on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:190
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:191
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:192
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:193
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:194
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:195
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/stream.d.ts:196
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "close", listener: () => void): this
once(event: "drain", listener: () => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: "finish", listener: () => void): this
once(event: "pipe", listener: (src: Readable) => void): this
once(event: "unpipe", listener: (src: Readable) => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:198
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:199
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:200
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:201
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:202
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:203
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/stream.d.ts:204
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pipe

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

Inherited from Sink.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: "close", listener: () => void): this
prependListener(event: "drain", listener: () => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: "finish", listener: () => void): this
prependListener(event: "pipe", listener: (src: Readable) => void): this
prependListener(event: "unpipe", listener: (src: Readable) => void): this
prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:206
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:207
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:208
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:209
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:210
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:211
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/stream.d.ts:212
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "close", listener: () => void): this
prependOnceListener(event: "drain", listener: () => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: "finish", listener: () => void): this
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:214
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:215
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:216
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:217
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:218
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:219
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:220
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from SseStream.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from SseStream.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: () => void): this
removeListener(event: "drain", listener: () => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: "finish", listener: () => void): this
removeListener(event: "pipe", listener: (src: Readable) => void): this
removeListener(event: "unpipe", listener: (src: Readable) => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:222
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:223
Parameters
- event: "drain"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:224
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:225
Parameters
- event: "finish"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:226
Parameters
- event: "pipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:227
Parameters
- event: "unpipe"
- listener: (src: Readable) => void
  - - (src: Readable): void
    - Parameters
      - src: Readable
      Returns void
Returns this
Inherited from Sink.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:228
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setDefaultEncoding

setDefaultEncoding(encoding: BufferEncoding): this

Inherited from Sink.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:156
Parameters
- encoding: BufferEncoding
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from SseStream.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

uncork

uncork(): void

Inherited from Sink.uncork
- Defined in node_modules/@types/node/stream.d.ts:161
Returns void

write

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

Inherited from Sink.write
- Defined in node_modules/@types/node/stream.d.ts:154
Parameters
- chunk: any
- Optional cb: (error: Error | null | undefined) => void
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean
Inherited from Sink.write
- Defined in node_modules/@types/node/stream.d.ts:155
Parameters
- chunk: any
- encoding: BufferEncoding
- Optional cb: (error: Error | null | undefined) => void
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional writeHead: (statusCode: number, headers?: OutgoingHttpHeaders | string) => void

Parameters

statusCode: number

Optional headers: OutgoingHttpHeaders | string

Returns void

Returns Sink

Properties

Private Readonly chunks

destroyed

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

Optional Readonly writeHead

Type declaration

Parameters

statusCode: number

Optional headers: OutgoingHttpHeaders | string

Returns void

Accessors

content

Returns string

Methods

_destroy

Parameters

error: Error | null

callback: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

_final

Parameters

callback: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

_write

Parameters

chunk: any

encoding: string

callback: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<{ chunk: any; encoding: BufferEncoding }>

callback: (error?: Error | null) => void

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns this

Parameters

event: "drain"

listener: () => void

Returns void

Returns this

Parameters