Class DeveloperAppDoc

Hierarchy (view full)

CustomTypeClass<DeveloperAppDoc>
- DeveloperAppDoc

Implements

iDeveloperAppDoc

Index

Constructors

Properties

_docId _id? clientId clientSecret createdBy description image name redirectUris

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new DeveloperAppDoc(data): DeveloperAppDoc
Parameters
- data: iDeveloperAppDoc
Returns DeveloperAppDoc
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:1450

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

clientId

clientId: string

The client ID of the app

clientSecret

clientSecret: string

The client secret of the app

createdBy

createdBy: string

Creator of the app

description

description: string

The description of the app

image

image: string

The image of the app

name

name: string

The name of the app

redirectUris

redirectUris: string[]

The redirect URI of the app

Methods

clone

clone(): DeveloperAppDoc
Deep copies the object and returns a new instance.

Returns DeveloperAppDoc
Overrides CustomTypeClass.clone
- Defined in src/api-indexer/docs/docs.ts:1467

convert

convert<U>(convertFunction, options?): DeveloperAppDoc
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns DeveloperAppDoc
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Overrides CustomTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:1463

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