Class Group

Hierarchy (View Summary)

Container
- Group

Index

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

`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

equals

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

exclude

exclude(key: Container, meta?: Meta): Promise<Muid>
Excludes a Muid or Container from the group.
Parameters
- key: Container
  either a Muid or container to exclude
- Optionalmeta: Meta
Returns Promise<Muid>
a promise that resolves to the Muid for the exclusion
- Defined in implementation/Group.ts:47

getMembers

getMembers(asOf?: AsOf): AsyncGenerator<Container, void>
Function to iterate over the containers in the group.
Parameters
- OptionalasOf: AsOf
  optional timestamp to look back to
Returns AsyncGenerator<Container, void>
an async iterator across all containers in the group
- Defined in implementation/Group.ts:85

getName

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

include

include(key: Container, meta?: Meta): Promise<Muid>
Includes a Muid or Container in the group.
Parameters
- key: Container
  either a container or a Muid to include
- Optionalmeta: Meta
Returns Promise<Muid>
a promise that resolves to the Muid for the inclusion
- Defined in implementation/Group.ts:37

includedAsArray

includedAsArray(asOf?: AsOf): Promise<Container[]>
Dumps the contents of this group to a javascript array.Only includes explicitly included members. useful for debugging and could also be used to export data by walking the tree
Parameters
- OptionalasOf: AsOf
  effective time to get the dump for: leave undefined to get data as of the present
Returns Promise<Container[]>
an array containing Values (e.g. numbers, strings) and Containers (e.g. other Lists, Boxes, Directories)
- Defined in implementation/Group.ts:108

isIncluded

isIncluded(key: Muid | Container, asOf?: AsOf): Promise<boolean>
Whether or not the given key is explicitly included in the group.
Parameters
- key: Muid | Container
  either a Muid or container to check if it is included
- OptionalasOf: AsOf
  optional timestamp to look back to
Returns Promise<boolean>
a promise that resolves to a boolean stating whether the key is explicitly included
- Defined in implementation/Group.ts:65

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/Group.ts:129

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(): Promise<number>
This returns the number of inclusions only, NOT exclusions.

Returns Promise<number>
how many containers are included in the group
Overrides Container.size
- Defined in implementation/Group.ts:55

toJson

toJson(
    indent?: number | boolean,
    asOf?: AsOf,
    seen?: Set<string>,
): Promise<string>
Generates a JSON representation of the data in the group. Mostly intended for demo/debug purposes.
Parameters
- indent: number | boolean = false
  true to pretty print (not yet implemented)
- OptionalasOf: AsOf
  optional timestamp to look back to
- Optionalseen: Set<string>
  (internal use only! This prevents cycles from breaking things)
Returns Promise<string>
a JSON string
Overrides Container.toJson
- Defined in implementation/Group.ts:210

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<Group>
Parameters
- Optionaldatabase: Database
- Optionalmeta: Meta
Returns Promise<Group>
- Defined in implementation/Group.ts:21

`Static`get

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

Class Group

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

ProtectedaddEntry

Parameters

Returns Promise<Muid>

clear

Parameters

Returns Promise<Muid>

equals

Parameters

Returns boolean

exclude

Parameters

Returns Promise<Muid>

getMembers

Parameters

Returns AsyncGenerator<Container, void>

getName

Parameters

Returns Promise<string>

include

Parameters

Returns Promise<Muid>

includedAsArray

Parameters

Returns Promise<Container[]>

isIncluded

Parameters

Returns Promise<boolean>

reset

Parameters

Returns Promise<void>

Argument

Argument

Argument

resetProperties

Parameters

Returns Promise<void>

setName

Parameters

Returns Promise<Muid>

size

Returns Promise<number>

toJson

Parameters

Returns Promise<string>

whatAmI

Returns string

Protected StaticaddContainer

Parameters

Returns Promise<Muid>

Staticcreate

Parameters

Returns Promise<Group>

Staticget

Parameters

Returns Group

Settings

`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