Class ManagerTimeline<T>

ManagerTimeline represents the value of the manager over time

Index

Constructors

constructor

Properties

manager timelineTimes

Methods

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

Constructors

constructor

new ManagerTimeline<T>(managerTimeline): ManagerTimeline<T>
Type Parameters
- T extends NumberType
Parameters
- managerTimeline: iManagerTimeline<T>
Returns ManagerTimeline<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/misc.ts:677

Properties

manager

manager: string

The manager of the collection.

timelineTimes

timelineTimes: UintRangeArray<T>

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

Methods

clone

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

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

convert

convert(convertFunction, options?): ManagerTimeline
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 ManagerTimeline
Overrides BaseNumberTypeClass.convert
- Defined in src/core/misc.ts:690

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.ManagerTimeline
Returns proto.badges.ManagerTimeline
- Defined in src/core/misc.ts:699

`Static`fromJson

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

`Static`fromJsonString

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

`Static`fromProto

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

`Static`required

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

`Static`validateUpdate

validateUpdate<T>(oldManager, newManager, canUpdateManager): null | Error
Wrapper for validateManagerUpdate
Type Parameters
- T extends NumberType
Parameters
- oldManager: ManagerTimeline<T>[]
- newManager: ManagerTimeline<T>[]
- canUpdateManager: TimedUpdatePermission<T>[]
Returns null | Error
- Defined in src/core/misc.ts:729

Class ManagerTimeline<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ManagerTimeline<T>

Properties

manager

timelineTimes

Methods

clone

Returns ManagerTimeline<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns ManagerTimeline<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.ManagerTimeline

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns ManagerTimeline<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns ManagerTimeline<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns ManagerTimeline<U>

Staticrequired

Returns ManagerTimeline<NumberType>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`required

`Static`validateUpdate