Class StandardsTimeline<T>

StandardsTimeline represents the value of the standards over time

Index

Constructors

constructor

Properties

standards timelineTimes

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto fromJson fromJsonString fromProto required validateUpdate

Constructors

constructor

new StandardsTimeline<T>(standardsTimeline): StandardsTimeline<T>
Type Parameters
- T extends NumberType
Parameters
- standardsTimeline: iStandardsTimeline<T>
Returns StandardsTimeline<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/misc.ts:1113

Properties

standards

standards: string[]

The standards.

timelineTimes

timelineTimes: UintRangeArray<T>

The times of the timeline item. Times in a timeline cannot overlap.

Methods

clone

clone(): StandardsTimeline<T>
Deep copies the object and returns a new instance.

Returns StandardsTimeline<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert(convertFunction, options?): StandardsTimeline
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns StandardsTimeline
Overrides BaseNumberTypeClass.convert
- Defined in src/core/misc.ts:1126

equals

equals(other, normalizeNumberTypes?): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Inherited from BaseNumberTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:127

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

toProto

toProto(): proto.badges.StandardsTimeline
Returns proto.badges.StandardsTimeline
- Defined in src/core/misc.ts:1135

`Static`fromJson

fromJson(jsonValue, convertFunction, options?): StandardsTimeline
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns StandardsTimeline
- Defined in src/core/misc.ts:1139

`Static`fromJsonString

fromJsonString(jsonString, convertFunction, options?): StandardsTimeline
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns StandardsTimeline
- Defined in src/core/misc.ts:1147

`Static`fromProto

fromProto(item, convertFunction): StandardsTimeline
Type Parameters
- U extends NumberType
Parameters
- item: proto.badges.StandardsTimeline
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns StandardsTimeline
- Defined in src/core/misc.ts:1155

`Static`required

required(): StandardsTimeline<NumberType>
Returns StandardsTimeline<NumberType>
- Defined in src/core/misc.ts:1119

`Static`validateUpdate

validateUpdate<T>(oldStandards, newStandards, canUpdateStandards): null | Error
Wrapper for validateStandardsUpdate
Type Parameters
- T extends NumberType
Parameters
- oldStandards: StandardsTimeline<T>[]
- newStandards: StandardsTimeline<T>[]
- canUpdateStandards: TimedUpdatePermission<T>[]
Returns null | Error
- Defined in src/core/misc.ts:1165

Class StandardsTimeline<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StandardsTimeline<T>

Properties

standards

timelineTimes

Methods

clone

Returns StandardsTimeline<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns StandardsTimeline<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.StandardsTimeline

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns StandardsTimeline<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns StandardsTimeline<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns StandardsTimeline<U>

Staticrequired

Returns StandardsTimeline<NumberType>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`required

`Static`validateUpdate