Interface IOverride<T>

The basic interface for a configuration override.

Remarks

Since clients will often have their own perferences types, this override could be backed by practically anything.

Type Parameters

Hierarchy

  • IOverride

Properties

activatedTime? allowedModes hash? id key minimumTime? preferences

Properties

Optional activatedTime

activatedTime?: number

The time this override is activated/installed.

Remarks

Clients should 100% ignore this property on incoming overrides.

allowedModes

allowedModes: OperationMode[]

The allowed modes for the current override. Not all clients will implement this.

Optional hash

hash?: number

An integrity hash for the current override.

Remarks

This package does not specify an algorithm or enforcement for this, so it's up to clients. Beta Protection uses a simple hash code and does enforce it.

id

id: string

The ID of the current override.

key

key: string

The unlock key for the current override.

Optional minimumTime

minimumTime?: number

The minimum amount of time (in minutes) that this override must be enabled before being unlockable.

preferences

preferences: Partial<T>

The preferences specified in this override to be, well, overridden.

Remarks

While clients are free to implement this themselves, the assumption is that any property not specified in the override is "unlocked".

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc