Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Transport
    • default

Index

Constructors

constructor

  • new default(options: EventLogConfig & TransportStreamOptions): default

Properties

destroyed

destroyed: boolean

Optional format

format: Format

Optional handleExceptions

handleExceptions: boolean

Optional level

level: string

Private Readonly logger

logger: EventLogger

Optional silent

silent: 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

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

Optional _construct

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

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

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

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

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

          • Optional error: null | Error

          Returns void

    Returns void

_final

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

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

          • Optional error: null | Error

          Returns void

    Returns void

_write

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

    • chunk: any
    • encoding: BufferEncoding
    • callback: (error?: null | Error) => void
        • (error?: null | Error): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional _writev

  • _writev(chunks: { chunk: any; encoding: BufferEncoding }[], callback: (error?: null | Error) => void): void
  • Parameters

    • chunks: { chunk: any; encoding: BufferEncoding }[]
    • callback: (error?: null | Error) => void
        • (error?: null | Error): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

addListener

  • addListener(event: "close", listener: () => void): default
  • addListener(event: "drain", listener: () => void): default
  • addListener(event: "error", listener: (err: Error) => void): default
  • addListener(event: "finish", listener: () => void): default
  • addListener(event: "pipe", listener: (src: Readable) => void): default
  • addListener(event: "unpipe", listener: (src: Readable) => void): default
  • addListener(event: string | symbol, listener: (...args: any[]) => void): default
  • 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 default

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns default

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

Optional close

  • close(): void
  • Returns void

cork

  • cork(): void
  • Returns void

destroy

  • destroy(error?: Error): void
  • 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
  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • Parameters

    • event: "pipe"
    • src: Readable

    Returns boolean

  • Parameters

    • event: "unpipe"
    • src: Readable

    Returns boolean

  • 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
  • Parameters

    • Optional cb: () => void
        • (): void
        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void
        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • Optional cb: () => void
        • (): void
        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

log

  • log(info: any, next: () => void): void

Optional logv

  • logv(info: any, next: () => void): any
  • Parameters

    • info: any
    • next: () => void
        • (): void
        • Returns void

    Returns any

off

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

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

on

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

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns default

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

once

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

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns default

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

pipe

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

    • T: WritableStream<T>

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

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

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns default

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

prependOnceListener

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

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns default

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

rawListeners

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

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): default
  • Parameters

    • Optional event: string | symbol

    Returns default

removeListener

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

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns default

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void
        • Returns void

    Returns default

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void
        • (src: Readable): void
        • Parameters

          • src: Readable

          Returns void

    Returns default

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): default
  • Parameters

    • encoding: BufferEncoding

    Returns default

setMaxListeners

  • setMaxListeners(n: number): default
  • Parameters

    • n: number

    Returns default

uncork

  • uncork(): void
  • Returns void

write

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

    • chunk: any
    • Optional cb: (error: undefined | null | Error) => void
        • (error: undefined | null | Error): void
        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • Optional cb: (error: undefined | null | Error) => void
        • (error: undefined | null | Error): void
        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc