Class Spec

ReadonlygroupThreshold

Readonlygroups

groupCount

• get groupCount(): number

  Number of groups.

  Returns number

shareCount

• get shareCount(): number

  Total shares across all groups.

  Returns number

StaticisSpec

• isSpec(value: unknown): value is Spec

  Type guard for a Spec, including one from another copy of this package.

  Parameters

  • value: unknown

  Returns value is Spec

Staticfrom

• from(options: SpecOptions): Spec

  A validated spec over a frozen copy of groups. The fields are read once and groups is snapshotted by index, so what is checked is what is stored; a GroupSpec from another copy of this package is rebuilt through this copy's factory.

  Parameters

  • options: SpecOptions

  Returns Spec

  Throws

  InvalidParameter unless options is an object, groupThreshold a usize and groups an array of GroupSpec; then GroupThresholdInvalid (0 or > groups), GroupCountInvalid (> 16), in the reference's order.

equals

• equals(other: unknown): boolean

  Same group threshold and pairwise equal groups; false for anything that is not a Spec (one from another copy of this package compares by its fields).

  Parameters

  • other: unknown

  Returns boolean