Skip to main content

percentComplete

Stentor API Reference


Stentor API Reference / stentor-utils/src / percentComplete

Function: percentComplete()

Call Signature​

percentComplete<T>(template, required): number

Defined in: packages/stentor-utils/src/object/percentComplete.ts:29

Calculates the percentage complete of the required parameters for the given template.

Type Parameters​

T​

T

Parameters​

template​

Partial<T>

required​

keyof T[]

Returns​

number

Call Signature​

percentComplete<T>(template, required, returnRemaining): PercentCompleteAndRemaining<T>

Defined in: packages/stentor-utils/src/object/percentComplete.ts:30

Calculates the percentage complete of the required parameters for the given template.

Type Parameters​

T​

T

Parameters​

template​

Partial<T>

required​

keyof T[]

returnRemaining​

true

Returns​

PercentCompleteAndRemaining<T>