Class DynamicDataDoc<Q>

Type Parameters

Q extends DynamicDataHandlerType

Hierarchy (view full)

CustomTypeClass<DynamicDataDoc<Q>>
- DynamicDataDoc

Implements

iDynamicDataDoc<Q>

Index

Constructors

Properties

_docId _id? createdBy data dataSecret dynamicDataId handlerId label

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new DynamicDataDoc<Q>(data): DynamicDataDoc<Q>
Type Parameters
- Q extends DynamicDataHandlerType
Parameters
- data: iDynamicDataDoc<Q>
Returns DynamicDataDoc<Q>
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:1418

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

createdBy

createdBy: string

data

data: DynamicDataHandlerData<Q>

dataSecret

dataSecret: string

dynamicDataId

dynamicDataId: string

handlerId

handlerId: Q

label

label: string

Methods

clone

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

Returns DynamicDataDoc<Q>
Overrides CustomTypeClass.clone
- Defined in src/api-indexer/docs/docs.ts:1430

convert

convert<U>(_convertFunction?, options?): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional_convertFunction: ((val: NumberType) => U)
  - - (val): U
    - Parameters
      val: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns CustomType<any>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Inherited from CustomTypeClass.convert
- Defined in src/common/base.ts:94

equals

equals<U>(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<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from CustomTypeClass.equals
- Defined in src/common/base.ts:71

getNumberFieldNames

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

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

hasNumberFields

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

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in src/common/base.ts:85

toJson

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

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in src/common/base.ts:63

toJsonString

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

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in src/common/base.ts:67