Class Spec

A specification for an SSKR split.

Index

Methods

new groupThreshold groups groupCount shareCount

Methods

`Static`new

new(groupThreshold: number, groups: GroupSpec[]): Spec
Creates a new Spec instance with the given group threshold and groups.
Parameters
- groupThreshold: number
  The minimum number of groups required to reconstruct the secret.
- groups: GroupSpec[]
  The list of GroupSpec instances that define the groups and their members.
Returns Spec
A new Spec instance.

Throws
SSKRError if the group threshold is zero, if the group threshold is greater than the number of groups, or if the number of groups is greater than the maximum share count.
- Defined in spec.ts:122

groupThreshold

groupThreshold(): number
Returns the group threshold.

Returns number
- Defined in spec.ts:138

groups

groups(): GroupSpec[]
Returns a slice of the group specifications.

Returns GroupSpec[]
- Defined in spec.ts:145

groupCount

groupCount(): number
Returns the number of groups.

Returns number
- Defined in spec.ts:152

shareCount

shareCount(): number
Returns the total number of shares across all groups.

Returns number
- Defined in spec.ts:159