Class SqrlEntity

Hierarchy

SqrlObject
- SqrlEntity

Index

Constructors

constructor

new SqrlEntity(uniqueId: SqrlUniqueId, type: string, value: string): SqrlEntity
Parameters
- uniqueId: SqrlUniqueId
- type: string
- value: string
Returns SqrlEntity
Overrides SqrlObject.constructor
- Defined in packages/sqrl/src/object/SqrlEntity.ts:22

Properties

entityId

entityId: EntityId

isSqrlObject

isSqrlObject: boolean

type

type: string

uniqueId

uniqueId: SqrlUniqueId

value

value: string

Methods

buildCounterKey

buildCounterKey(ctx: Context, ...featureValues: any[]): Promise<SqrlKey>
Parameters
- ctx: Context
- Rest ...featureValues: any[]
Returns Promise<SqrlKey>
- Defined in packages/sqrl/src/object/SqrlEntity.ts:80

buildCounterKeyList

buildCounterKeyList(ctx: Context, ...featureValues: any[]): Promise<SqrlKey[]>
Parameters
- ctx: Context
- Rest ...featureValues: any[]
Returns Promise<SqrlKey[]>
- Defined in packages/sqrl/src/object/SqrlEntity.ts:117

getBasicValue

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

getData

getData(): {
    type: string;
    uniqueId: {
        remaining: number;
        time: string;
    };
    value: string;
}
Returns {
    type: string;
    uniqueId: {
        remaining: number;
        time: string;
    };
    value: string;
}
- type: string
- uniqueId: {
  remaining: number;
  time: string;
  }
  - remaining: number
  - time: string
- value: string
Overrides SqrlObject.getData
- Defined in packages/sqrl/src/object/SqrlEntity.ts:72

getEntityId

getEntityId(): EntityId
Returns EntityId
- Defined in packages/sqrl/src/object/SqrlEntity.ts:40

getNumberString

getNumberString(): string
Returns string
- Defined in packages/sqrl/src/object/SqrlEntity.ts:47

getTimeMs

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

getUniqueId

getUniqueId(): UniqueId
Returns UniqueId
- Defined in packages/sqrl/src/object/SqrlEntity.ts:53

render

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

tryGetFeatureType

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

tryGetOfClass

tryGetOfClass(cls: any): SqrlEntity
Parameters
- cls: any
Returns SqrlEntity
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/SqrlEntity.ts:50

`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