Class export=

constructor

• new "export="(): export=

  Returns export=

Static ReadonlyKINDS

StaticappendEvent

• appendEvent(key: string, entityId: string, value: string): boolean

  Appends one event to a subordinate's log, never replacing a value.

  Parameters

  • key: string

    the subordinate's key

  • entityId: string

    its Entity Identifier, if any

  • value: string

    the event's JSON text

  Returns boolean

  true when the directory wrote it

StaticcnOf

• cnOf(kind: string, key: string): string

  Answers the cn of the entry of a kind about a key.

  Parameters

  • kind: string

    one of KINDS

  • key: string

    what the entry is about

  Returns string

  the kind's prefix and the key's digest, or the kind itself for a realm's one keys or collection entry

Staticdigest

• digest(value: string): string

  Answers the digest an entry is named by: SHA-256 in hex, cut to 32 characters.

  Parameters

  • value: string

    what the entry is about: an Entity Identifier, a type or a JWT

  Returns string

  the digest

Staticentries

• entries(kind: string): Entry[]

  Lists every entry of a kind in the ambient realm, oldest first.

  Parameters

  • kind: string

    one of KINDS

  Returns Entry[]

  the entries: cn, kind, Entity Identifier, data and times

StaticeventValues

• eventValues(key: string): string[]

  Reads a subordinate's event log: the values of the events entry about its key.

  Parameters

  • key: string

    the subordinate's key

  Returns string[]

  each event's JSON text

Staticget

• get(kind: string, key: string): Entry

  Reads the entry of a kind about a key.

  Parameters

  • kind: string

    one of KINDS

  • key: string

    what the entry is about

  Returns Entry

  the entry, or null

StatickeyRows

• keyRows(): any[]

  Reads the rows of the realm's Federation Entity Key table, one JSON value each.

  Returns any[]

  the rows

Staticput

• put(kind: string, key: string, entityId: string, data: any): boolean

  Writes the entry of a kind about a key, created or replaced whole.

  Parameters

  • kind: string

    one of KINDS

  • key: string

    what the entry is about

  • entityId: string

    the Entity Identifier it concerns, if any

  • data: any

    the record, stored as one JSON value

  Returns boolean

  true when the directory wrote it

Staticremove

• remove(kind: string, key: string): boolean

  Deletes the entry of a kind about a key.

  Parameters

  • kind: string

    one of KINDS

  • key: string

    what the entry is about

  Returns boolean

  true when the directory deleted it

StatictimeOf

• timeOf(values: any): number

  Reads a generalized time as epoch milliseconds.

  Parameters

  • values: any

    the attribute's value or values

  Returns number

  the time, or 0 when there is none

StaticwriteKeyRows

• writeKeyRows(rows: any[]): boolean

  Writes the realm's Federation Entity Key table, one value per row.

  Parameters

  • rows: any[]

    the rows

  Returns boolean

  true when the directory wrote it