Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsStream

Hierarchy

  • Readable
    • LogsStream

Implements

  • ReadableStream

Index

Constructors

constructor

Properties

Private _interval

_interval: Timeout | undefined

Private _pollingCacheSize

_pollingCacheSize: number

Private _pollingFrequency

_pollingFrequency: number

Private _viewedLogs

_viewedLogs: Array<{ dateCreated: Date; sid: Sid }>

Private _viewedSids

_viewedSids: Set<Sid>

Private client

Private config

config: LogsConfig

destroyed

destroyed: boolean

Private environmentSid

environmentSid: Sid

readable

readable: boolean

Readonly readableEncoding

readableEncoding: BufferEncoding | null

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean | null

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

Private serviceSid

serviceSid: Sid

Accessors

pollingFrequency

  • set pollingFrequency(frequency: number): void
  • Parameters

    • frequency: number

    Returns void

Methods

[Symbol.asyncIterator]

  • [Symbol.asyncIterator](): AsyncIterableIterator<any>

_destroy

  • _destroy(): void
  • Returns void

_poll

  • _poll(): Promise<void>
  • Returns Promise<void>

_read

  • _read(): void
  • Returns void

addListener

  • addListener(event: "close", listener: () => void): this
  • addListener(event: "data", listener: (chunk: any) => void): this
  • addListener(event: "end", listener: () => void): this
  • addListener(event: "error", listener: (err: Error) => void): this
  • addListener(event: "pause", listener: () => void): this
  • addListener(event: "readable", listener: () => void): this
  • addListener(event: "resume", listener: () => void): this
  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

destroy

  • destroy(error?: Error): void
  • Parameters

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean
  • Returns boolean

listenerCount

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

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this
  • 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: "data", listener: (chunk: any) => void): this
  • on(event: "end", listener: () => void): this
  • on(event: "error", listener: (err: Error) => void): this
  • on(event: "pause", listener: () => void): this
  • on(event: "readable", listener: () => void): this
  • on(event: "resume", listener: () => void): this
  • on(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

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

    Returns this

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • 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: "data", listener: (chunk: any) => void): this
  • once(event: "end", listener: () => void): this
  • once(event: "error", listener: (err: Error) => void): this
  • once(event: "pause", listener: () => void): this
  • once(event: "readable", listener: () => void): this
  • once(event: "resume", listener: () => void): this
  • once(event: string | symbol, listener: (...args: any[]) => void): this

pause

  • pause(): this
  • Returns this

pipe

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

    • T: WritableStream

    Parameters

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

    Returns T

prependListener

  • prependListener(event: "close", listener: () => void): this
  • prependListener(event: "data", listener: (chunk: any) => void): this
  • prependListener(event: "end", listener: () => void): this
  • prependListener(event: "error", listener: (err: Error) => void): this
  • prependListener(event: "pause", listener: () => void): this
  • prependListener(event: "readable", listener: () => void): this
  • prependListener(event: "resume", listener: () => void): this
  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

prependOnceListener

  • prependOnceListener(event: "close", listener: () => void): this
  • prependOnceListener(event: "data", listener: (chunk: any) => void): this
  • prependOnceListener(event: "end", listener: () => void): this
  • prependOnceListener(event: "error", listener: (err: Error) => void): this
  • prependOnceListener(event: "pause", listener: () => void): this
  • prependOnceListener(event: "readable", listener: () => void): this
  • prependOnceListener(event: "resume", listener: () => void): this
  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

push

  • push(chunk: any, encoding?: BufferEncoding): boolean
  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns boolean

rawListeners

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

    • event: string | symbol

    Returns Function[]

read

  • read(size?: undefined | number): any
  • Parameters

    • Optional size: undefined | number

    Returns any

removeAllListeners

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

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: "close", listener: () => void): this
  • removeListener(event: "data", listener: (chunk: any) => void): this
  • removeListener(event: "end", listener: () => void): this
  • removeListener(event: "error", listener: (err: Error) => void): this
  • removeListener(event: "pause", listener: () => void): this
  • removeListener(event: "readable", listener: () => void): this
  • removeListener(event: "resume", listener: () => void): this
  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

resume

  • resume(): this
  • Returns this

setEncoding

  • setEncoding(encoding: BufferEncoding): this
  • Parameters

    • encoding: BufferEncoding

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

unpipe

  • unpipe(destination?: NodeJS.WritableStream): this
  • Parameters

    • Optional destination: NodeJS.WritableStream

    Returns this

unshift

  • unshift(chunk: any, encoding?: BufferEncoding): void
  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns void

wrap

  • wrap(oldStream: ReadableStream): this
  • Parameters

    • oldStream: ReadableStream

    Returns this

Static from

  • from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable
  • A utility method for creating Readable Streams out of iterators.

    Parameters

    • iterable: Iterable<any> | AsyncIterable<any>
    • Optional options: ReadableOptions

    Returns Readable

Generated using TypeDoc