Class KeySet

Hierarchy (View Summary)

Container
- KeySet

Index

Properties

address behavior database DELETION globalPropertyMuid INCLUSION

Accessors

Methods

[inspectSymbol] add addEntry clear delete entries equals getName has reset resetProperties setName size toJson toSet update whatAmI addContainer create get

Properties

`Readonly`address

address: Muid

`Readonly`behavior

behavior: Behavior

`Readonly`database

database: Database

`Protected` `Static` `Readonly`DELETION

DELETION: Deletion = ...

`Protected` `Static`globalPropertyMuid

globalPropertyMuid: { medallion: number; offset: Behavior; timestamp: number } = ...

`Protected` `Static` `Readonly`INCLUSION

INCLUSION: Inclusion = ...

Accessors

medallion

get medallion(): number
Returns number
Inherited from Container.medallion
- Defined in implementation/Addressable.ts:18

offset

get offset(): number
Returns number
Inherited from Container.offset
- Defined in implementation/Addressable.ts:21

timestamp

get timestamp(): number
Returns number
Inherited from Container.timestamp
- Defined in implementation/Addressable.ts:15

Methods

[inspectSymbol]

"[inspectSymbol]"(depth: any, opts: any): string
Parameters
- depth: any
- opts: any
Returns string
Inherited from Container.[inspectSymbol]
- Defined in implementation/Container.ts:36

add

add(key: ScalarKey, meta?: Meta): Promise<Muid>
Adds a key to the keyset. If a bundler is supplied, the function will add the entry to that bundler and return immediately (presumably you know what to do with a CS if you passed it in). If the caller does not supply a bundler, then one is created on the fly, and then this method will await on the CS being added to the database instance. This is to allow simple console usage like: await myKeySet.add("foo");
Parameters
- key: ScalarKey
- Optionalmeta: Meta
Returns Promise<Muid>
a promise that resolves to the address of the newly created entry
- Defined in implementation/KeySet.ts:47

`Protected`addEntry

addEntry(
    key?:
        | ScalarKey
        | Muid
        | [Muid, Muid]
        | Addressable
        | [Addressable, Addressable],
    value?: Value | Deletion | Inclusion,
    meta?: Meta,
    onContainer?: Muid,
): Promise<Muid>
Parameters
- Optionalkey: ScalarKey | Muid | [Muid, Muid] | Addressable | [Addressable, Addressable]
- Optionalvalue: Value | Deletion | Inclusion
- Optionalmeta: Meta
- OptionalonContainer: Muid
Returns Promise<Muid>
Inherited from Container.addEntry
- Defined in implementation/Container.ts:142

clear

clear(purge?: boolean, meta?: Meta): Promise<Muid>
Parameters
- Optionalpurge: boolean
- Optionalmeta: Meta
Returns Promise<Muid>
Inherited from Container.clear
- Defined in implementation/Container.ts:115

delete

delete(key: ScalarKey, meta?: Meta): Promise<Muid>
Adds a deletion marker (tombstone) for a particular key in the directory. The corresponding value will be seen to be unset in the data model.
Parameters
- key: ScalarKey
- Optionalmeta: Meta
Returns Promise<Muid>
a promise that resolves to the address of the newly created deletion entry
- Defined in implementation/KeySet.ts:74

entries

entries(asOf?: AsOf): AsyncGenerator<[ScalarKey, ScalarKey], void>
Function to iterate over the contents of the key set.
Parameters
- OptionalasOf: AsOf
Returns AsyncGenerator<[ScalarKey, ScalarKey], void>
an async iterator across everything in the key set, with values returned as pairs of Key, Key
- Defined in implementation/KeySet.ts:83

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from Container.equals
- Defined in implementation/Addressable.ts:6

getName

getName(asOf?: AsOf): Promise<string>
Parameters
- OptionalasOf: AsOf
Returns Promise<string>
Inherited from Container.getName
- Defined in implementation/Container.ts:105

has

has(key: ScalarKey, asOf?: AsOf): Promise<boolean>
Returns whether the key set has a key or not.
Parameters
- key: ScalarKey
- OptionalasOf: AsOf
Returns Promise<boolean>
true if the key set has the key, false if not.
- Defined in implementation/KeySet.ts:105

reset

reset(toTime?: AsOf, recurse?: any, meta?: Meta): Promise<void>
Reset this Container to a previous time. If no time is specified, the container will be cleared.
Parameters
- OptionaltoTime: AsOf
- Optionalrecurse: any
- Optionalmeta: Meta
Returns Promise<void>
Argument
toTime Optional time to reset to. If absent, the container will be cleared.

Argument
recurse Recursively reset all child containers held by this container at reset time?

Argument
meta Metadata to be used in the reset.
Overrides Container.reset
- Defined in implementation/KeySet.ts:117

resetProperties

resetProperties(toTime?: AsOf, meta?: Meta): Promise<void>
Reset the properties associated with this container to a previous time.
Parameters
- OptionaltoTime: AsOf
  optional timestamp to reset to. If not provided, the properties will be deleted.
- Optionalmeta: Meta
Returns Promise<void>
Inherited from Container.resetProperties
- Defined in implementation/Container.ts:216

setName

setName(name: string, meta?: Meta): Promise<Muid>
Parameters
- name: string
- Optionalmeta: Meta
Returns Promise<Muid>
Inherited from Container.setName
- Defined in implementation/Container.ts:96

size

size(asOf?: AsOf): Promise<number>
How many entries are in the key set.
Parameters
- OptionalasOf: AsOf
Returns Promise<number>
a promise that resolves to a number.
Overrides Container.size
- Defined in implementation/KeySet.ts:212

toJson

toJson(
    indent?: number | boolean,
    asOf?: AsOf,
    seen?: Set<string>,
): Promise<string>
Generates a JSON representation of the data in the key set. Mostly intended for demo/debug purposes.
Parameters
- indent: number | boolean = false
  true to pretty print
- OptionalasOf: AsOf
  effective time
- Optionalseen: Set<string>
  (internal use only! This prevents cycles from breaking things)
Returns Promise<string>
a JSON string
Overrides Container.toJson
- Defined in implementation/KeySet.ts:228

toSet

toSet(asOf?: AsOf): Promise<Set<ScalarKey>>
Returns the contents of the key set as a set.
Parameters
- OptionalasOf: AsOf
Returns Promise<Set<ScalarKey>>
a promise that resolves to a set with KeyTypes.
- Defined in implementation/KeySet.ts:194

update

update(keys: Iterable<ScalarKey>, meta?: Meta): Promise<void>
Similar to add method, but for multiple entries.
Parameters
- keys: Iterable<ScalarKey>
  an iterable of keys to add to the key set
- Optionalmeta: Meta
Returns Promise<void>
a promise that resolves to a Bundler object for the created entries.
- Defined in implementation/KeySet.ts:57

whatAmI

whatAmI(): string
Returns string
Inherited from Container.whatAmI
- Defined in implementation/Container.ts:63

`Protected` `Static`addContainer

addContainer(
    __namedParameters: {
        behavior: Behavior;
        database: Database;
        meta?: Meta;
    },
): Promise<Muid>
Parameters
- __namedParameters: { behavior: Behavior; database: Database; meta?: Meta }
Returns Promise<Muid>
Inherited from Container.addContainer
- Defined in implementation/Container.ts:69

`Static`create

create(database?: Database, meta?: Meta): Promise<KeySet>
Parameters
- Optionaldatabase: Database
- Optionalmeta: Meta
Returns Promise<KeySet>
- Defined in implementation/KeySet.ts:25

`Static`get

get(database?: Database, muid?: Muid): KeySet
Parameters
- Optionaldatabase: Database
- Optionalmuid: Muid
Returns KeySet
- Defined in implementation/KeySet.ts:17

Class KeySet

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Readonlyaddress

Readonlybehavior

Readonlydatabase

Protected Static ReadonlyDELETION

Protected StaticglobalPropertyMuid

Protected Static ReadonlyINCLUSION

Accessors

medallion

Returns number

offset

Returns number

timestamp

Returns number

Methods

[inspectSymbol]

Parameters

Returns string

add

Parameters

Returns Promise<Muid>

ProtectedaddEntry

Parameters

Returns Promise<Muid>

clear

Parameters

Returns Promise<Muid>

delete

Parameters

Returns Promise<Muid>

entries

Parameters

Returns AsyncGenerator<[ScalarKey, ScalarKey], void>

equals

Parameters

Returns boolean

getName

Parameters

Returns Promise<string>

has

Parameters

Returns Promise<boolean>

reset

Parameters

Returns Promise<void>

Argument

Argument

Argument

resetProperties

Parameters

Returns Promise<void>

setName

Parameters

Returns Promise<Muid>

size

Parameters

Returns Promise<number>

toJson

Parameters

Returns Promise<string>

toSet

Parameters

Returns Promise<Set<ScalarKey>>

update

Parameters

Returns Promise<void>

whatAmI

Returns string

Protected StaticaddContainer

Parameters

Returns Promise<Muid>

Staticcreate

Parameters

Returns Promise<KeySet>

`Readonly`address

`Readonly`behavior

`Readonly`database

`Protected` `Static` `Readonly`DELETION

`Protected` `Static`globalPropertyMuid

`Protected` `Static` `Readonly`INCLUSION

`Protected`addEntry

`Protected` `Static`addContainer

`Static`create

`Static`get