Class Record

Hierarchy

  • SchemaMember
    • Record

Constructors

constructor

Properties

[SC]

Accessors

address deleted feed hasConflict id key latest length links lseq path schema seq shortAddress timestamp type value

Methods

_latest addVersion allVersions currentVersions fields get getField getMany getOne getType hasField hasType hasVersion inspect subscribe toJSON update

Constructors

constructor

Properties

[SC]

[SC]: Schema

Accessors

address

  • get address(): string

  • Returns string

deleted

  • get deleted(): undefined | boolean

  • Returns undefined | boolean

feed

  • get feed(): undefined | string

  • Returns undefined | string

hasConflict

  • get hasConflict(): boolean

  • Returns boolean

id

  • get id(): string

  • Returns string

key

  • get key(): undefined | string

  • Returns undefined | string

latest

length

  • get length(): number

  • Returns number

links

  • Returns string[]

lseq

  • get lseq(): undefined | number

  • Returns undefined | number

path

  • get path(): string

  • Returns string

schema

  • Returns Schema

seq

  • get seq(): undefined | number

  • Returns undefined | number

shortAddress

  • get shortAddress(): string

  • Returns string

timestamp

  • get timestamp(): string | 0

  • Returns string | 0

type

  • get type(): string

  • Returns string

value

Methods

_latest

addVersion

allVersions

currentVersions

fields

get

  • get(fieldName: string): any

  • Parameters

    • fieldName: string

    Returns any

getField

  • getField(fieldName: string): undefined | Field

  • Parameters

    • fieldName: string

    Returns undefined | Field

getMany

  • getMany(fieldName: string): any[]

  • Parameters

    • fieldName: string

    Returns any[]

getOne

  • getOne(fieldName: string): any

  • Parameters

    • fieldName: string

    Returns any

getType

  • getType(): undefined | Type

  • Returns undefined | Type

hasField

  • hasField(fieldName: string): boolean

  • Parameters

    • fieldName: string

    Returns boolean

hasType

  • hasType(typeAddress: string): boolean

  • Parameters

    • typeAddress: string

    Returns boolean

hasVersion

inspect

subscribe

  • subscribe(fn: EmitCb<Record>, triggerNow?: boolean): (() => void)

  • Subscribe to changes to this record.

    Parameters

    Returns (() => void)

      • (): void

      • Subscribe to changes to this record.

        Returns void

toJSON

  • toJSON(): { deleted: undefined | boolean; id: string; key: undefined | string; links: string[]; lseq: undefined | number; seq: undefined | number; timestamp: string | number; type: string; value: RecordValue }

  • Returns { deleted: undefined | boolean; id: string; key: undefined | string; links: string[]; lseq: undefined | number; seq: undefined | number; timestamp: string | number; type: string; value: RecordValue }

    • deleted: undefined | boolean
    • id: string
    • key: undefined | string
    • links: string[]
    • lseq: undefined | number
    • seq: undefined | number
    • timestamp: string | number
    • type: string
    • value: RecordValue

update

Settings

Member Visibility

Theme

Generated using TypeDoc