Skip to content

@ralphschuler.logger.animations.ProgressBarAnimation.ProgressBarAnimation

github-actions edited this page Nov 26, 2023 · 1 revision

Class: ProgressBarAnimation

@ralphschuler/logger.animations/ProgressBarAnimation.ProgressBarAnimation

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ProgressBarAnimation(totalSteps): ProgressBarAnimation

Parameters

Name Type
totalSteps number

Returns

ProgressBarAnimation

Overrides

BaseAnimation.constructor

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:11

Properties

currentFrameIndex

Protected currentFrameIndex: number = 0

Inherited from

BaseAnimation.currentFrameIndex

Defined in

packages/logger/src/animations/BaseAnimation.ts:5


currentStep

Private currentStep: number = 0

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:8


frameDelay

Protected frameDelay: number

Inherited from

BaseAnimation.frameDelay

Defined in

packages/logger/src/animations/BaseAnimation.ts:8


frames

Protected frames: string[]

Inherited from

BaseAnimation.frames

Defined in

packages/logger/src/animations/BaseAnimation.ts:4


interval

Protected interval: null | Timeout = null

Inherited from

BaseAnimation.interval

Defined in

packages/logger/src/animations/BaseAnimation.ts:6


isAnimating

Protected isAnimating: boolean = false

Inherited from

BaseAnimation.isAnimating

Defined in

packages/logger/src/animations/BaseAnimation.ts:7


message

Protected message: string

Inherited from

BaseAnimation.message

Defined in

packages/logger/src/animations/BaseAnimation.ts:10


originalMessage

Private originalMessage: string = ""

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:9


proxy

Protected proxy: IMessage

Inherited from

BaseAnimation.proxy

Defined in

packages/logger/src/animations/BaseAnimation.ts:9


totalSteps

Private totalSteps: number

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:7

Methods

clearCurrentLine

clearCurrentLine(): void

Returns

void

Inherited from

BaseAnimation.clearCurrentLine

Defined in

packages/logger/src/animations/BaseAnimation.ts:27


generateProgressBarFrames

generateProgressBarFrames(): string[]

Returns

string[]

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:46


moveToNextFrame

moveToNextFrame(): void

Returns

void

Overrides

BaseAnimation.moveToNextFrame

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:39


patchMessage

patchMessage(): void

Returns

void

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:17


printCurrentFrame

printCurrentFrame(): void

Returns

void

Inherited from

BaseAnimation.printCurrentFrame

Defined in

packages/logger/src/animations/BaseAnimation.ts:32


setMessage

setMessage(message): void

Parameters

Name Type
message string

Returns

void

Overrides

BaseAnimation.setMessage

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:34


setProgress

setProgress(step): void

Parameters

Name Type
step number

Returns

void

Defined in

packages/logger/src/animations/ProgressBarAnimation.ts:65


start

start(message?): void

Parameters

Name Type
message? string

Returns

void

Inherited from

BaseAnimation.start

Defined in

packages/logger/src/animations/BaseAnimation.ts:43


stop

stop(message?): void

Parameters

Name Type
message? string

Returns

void

Inherited from

BaseAnimation.stop

Defined in

packages/logger/src/animations/BaseAnimation.ts:58

Typescript Libraries

Modules

Namespaces

Clone this wiki locally