Class SqrlKey

Hierarchy

SqrlObject
- SqrlKey

Constructors

constructor

new SqrlKey(databaseSet: DatabaseSet, counterEntity: SqrlEntity, featureValues: any[], timeMs: number, featuresHash: Buffer): SqrlKey
Parameters
- databaseSet: DatabaseSet
- counterEntity: SqrlEntity
- featureValues: any[]
- timeMs: number
- featuresHash: Buffer
Returns SqrlKey
Overrides SqrlObject.constructor
- Defined in packages/sqrl/src/object/SqrlKey.ts:20

Properties

buffer

buffer: Buffer

counterEntity

counterEntity: SqrlEntity

databaseSet

databaseSet: DatabaseSet

featureValues

featureValues: any[]

featuresHash

featuresHash: Buffer

isSqrlObject

isSqrlObject: boolean

shardValue

shardValue: number

timeMs

timeMs: number

Methods

getBasicValue

getBasicValue(): string
Returns string
Overrides SqrlObject.getBasicValue
- Defined in packages/sqrl/src/object/SqrlKey.ts:103

getBuffer

getBuffer(): Buffer
Returns Buffer
- Defined in packages/sqrl/src/object/SqrlKey.ts:89

getData

getData(): {
    counter: {
        type: string;
        uniqueId: {
            remaining: number;
            time: string;
        };
        value: string;
    };
    featureValues: any[];
    key: string;
    shardValue: number;
    time: string;
}
Returns {
    counter: {
        type: string;
        uniqueId: {
            remaining: number;
            time: string;
        };
        value: string;
    };
    featureValues: any[];
    key: string;
    shardValue: number;
    time: string;
}
- counter: {
      type: string;
      uniqueId: {
          remaining: number;
          time: string;
      };
      value: string;
  }
  - type: string
  - uniqueId: {
    remaining: number;
    time: string;
    }
    - remaining: number
    - time: string
  - value: string
- featureValues: any[]
- key: string
- shardValue: number
- time: string
Overrides SqrlObject.getData
- Defined in packages/sqrl/src/object/SqrlKey.ts:93

getDebugString

getDebugString(): string
Returns string
- Defined in packages/sqrl/src/object/SqrlKey.ts:45

getFeatureValues

getFeatureValues(): any[]
Returns any[]
- Defined in packages/sqrl/src/object/SqrlKey.ts:85

getHex

getHex(): string
Returns string
- Defined in packages/sqrl/src/object/SqrlKey.ts:73

getShardValue

getShardValue(): number
Returns number
- Defined in packages/sqrl/src/object/SqrlKey.ts:81

getTimeMs

getTimeMs(): any
Returns any
Inherited from SqrlObject.getTimeMs
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:9

render

render(): RenderedSpan
Returns RenderedSpan
Overrides SqrlObject.render
- Defined in packages/sqrl/src/object/SqrlKey.ts:58

tryGetFeatureType

tryGetFeatureType(): any
Returns any
Inherited from SqrlObject.tryGetFeatureType
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:6

tryGetOfClass

tryGetOfClass(cls: any): SqrlKey
Parameters
- cls: any
Returns SqrlKey
Inherited from SqrlObject.tryGetOfClass
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:8

tryGetTimeMs

tryGetTimeMs(): number
Returns number
Overrides SqrlObject.tryGetTimeMs
- Defined in packages/sqrl/src/object/SqrlKey.ts:77

`Static` ensureBasic

ensureBasic(val: any, expandData?: any): any
Parameters
- val: any
- Optional expandData: any
Returns any
Inherited from SqrlObject.ensureBasic
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:17

`Static` ensureBasicTypeValue

ensureBasicTypeValue(value: any, expandData?: boolean): {
type: string;
value: any;
}
Parameters
- value: any
- Optional expandData: boolean
Returns {
type: string;
value: any;
}
- type: string
- value: any
Inherited from SqrlObject.ensureBasicTypeValue
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:13

`Static` ensureOfClass

ensureOfClass(val: any, cls: any): SqrlObject
Parameters
- val: any
- cls: any
Returns SqrlObject
Inherited from SqrlObject.ensureOfClass
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:18

`Static` isBasic

isBasic(val: any): any
Parameters
- val: any
Returns any
Inherited from SqrlObject.isBasic
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:12

`Static` isTruthy

isTruthy(obj: any): boolean
Parameters
- obj: any
Returns boolean
Inherited from SqrlObject.isTruthy
- Defined in packages/sqrl-common/lib/SqrlObject.d.ts:11

Generated using TypeDoc