Class AccessTokenDoc

Hierarchy (view full)

CustomTypeClass<AccessTokenDoc>
- AccessTokenDoc

Implements

iAccessTokenDoc

Index

Constructors

Properties

_docId _id? accessToken accessTokenExpiresAt address bitbadgesAddress clientId refreshToken refreshTokenExpiresAt scopes tokenType

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

new AccessTokenDoc(data): AccessTokenDoc
Parameters
- data: iAccessTokenDoc
Returns AccessTokenDoc
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:1188

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

accessToken

accessToken: string

accessTokenExpiresAt

accessTokenExpiresAt: number

address

address: string

bitbadgesAddress

bitbadgesAddress: string

clientId

clientId: string

refreshToken

refreshToken: string

refreshTokenExpiresAt

refreshTokenExpiresAt: number

scopes

scopes: OAuthScopeDetails[]

tokenType

tokenType: string

Methods

clone

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

Returns AccessTokenDoc
Overrides CustomTypeClass.clone
- Defined in src/api-indexer/docs/docs.ts:1207

convert

convert<U>(convertFunction): AccessTokenDoc
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
Returns AccessTokenDoc
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:1203

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:54

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:64

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:46

toJsonString

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

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