Class GroupSpec

ReadonlymemberThreshold

ReadonlymemberCount

Static ReadonlyDEFAULT

StaticisGroupSpec

• isGroupSpec(value: unknown): value is GroupSpec

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

  Parameters

  • value: unknown

  Returns value is GroupSpec

Staticfrom

• from(options: GroupSpecOptions): GroupSpec

  A validated memberThreshold-of-memberCount. Each field is read once.

  Parameters

  • options: GroupSpecOptions

  Returns GroupSpec

  Throws

  InvalidParameter unless options is an object and both fields are usizes (a non-negative integer number up to 2^64, or a bigint in [0, 2^64 - 1]); then, in the reference's order, MemberCountInvalid (0 or > 16), MemberThresholdInvalid (> count). A threshold of 0 passes, as it does in GroupSpec::new; generating with it fails as Shamir (cause InvalidThreshold).

Staticparse

• parse(text: string): GroupSpec

  Parse "<threshold>-of-<count>"; each side is digits with an optional leading +, nothing else, up to u64::MAX.

  Parameters

  • text: string

  Returns GroupSpec

  Throws

  InvalidParameter unless text is a string; GroupSpecInvalid, then the from codes.

equals

• equals(other: unknown): boolean

  Same threshold and count; false for anything that is not a GroupSpec (one from another copy of this package compares by its fields).

  Parameters

  • other: unknown

  Returns boolean

toString

• toString(): string

  "<threshold>-of-<count>"

  Returns string