Class TerminalAnimation

Hierarchy

TerminalAnimation

Index

Constructors

Properties

currentFrame empty endFrame extraPadding frameMs frames intervalTimeout printLength printed streamLog theme

Methods

clearFrame loop nextFrame printFrame start stop

Constructors

constructor

new TerminalAnimation(theme: Theme, streamLog: ((str: string) => void), frames?: string[], frameMs?: number): TerminalAnimation
Throws
FalkorError: TerminalAnimationErrorCodes.FRAME_COUNT

Throws
FalkorError: TerminalAnimationErrorCodes.INVALID_FRAME
Parameters
- theme: Theme
- streamLog: ((str: string) => void)
  - - (str: string): void
    - Parameters
      
      str: string
      
      Returns void
- frames: string[] = ...
- frameMs: number = 500
Returns TerminalAnimation

Properties

`Protected` currentFrame

currentFrame: number

`Protected` `Readonly` empty

empty: string

`Protected` `Readonly` endFrame

endFrame: number

`Protected` extraPadding

extraPadding: number

`Protected` frameMs

frameMs: number = 500

`Protected` frames

frames: string[]

`Protected` intervalTimeout

intervalTimeout: Timeout

`Protected` `Readonly` printLength

printLength: number

`Protected` printed

printed: boolean

`Protected` streamLog

streamLog: ((str: string) => void)

Type declaration

- (str: string): void
- Parameters
  - str: string
  Returns void

`Protected` theme

theme: Theme

Methods

clearFrame

clearFrame(): void
Returns void

`Protected` loop

loop(): void
Returns void

`Protected` nextFrame

nextFrame(): void
Returns void

printFrame

printFrame(): void
Returns void

start

start(padding?: number): Promise<void>
Throws
FalkorError: TerminalAnimationErrorCodes.INVALID_PADDING
Parameters
- padding: number = 0
Returns Promise<void>

stop

stop(): void
Returns void