Class Box

Hierarchy (View Summary)

Container
- Box

Index

Properties

address behavior database DELETION globalPropertyMuid INCLUSION

Accessors

Methods

[inspectSymbol] addEntry clear equals get getName isEmpty reset resetProperties set setName size toJson 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

`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

get

get(asOf?: AsOf): Promise<Value | Container>
Returns a promise that resolves to the most recent value put in the box, or undefined.
Parameters
- OptionalasOf: AsOf
Returns Promise<Value | Container>
undefined, a basic value, or a container
- Defined in implementation/Box.ts:54

getName

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

isEmpty

isEmpty(asOf?: AsOf): Promise<boolean>
checks to see if something is in the box
Parameters
- OptionalasOf: AsOf
Returns Promise<boolean>
true if no value or container is in the box
- Defined in implementation/Box.ts:112

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/Box.ts:77

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

set

set(value: Value | Container, meta?: Meta): Promise<Muid>
Puts a value or a reference to another container in this box. 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 myBox.put("some value");
Parameters
- value: Value | Container
- Optionalmeta: Meta
Returns Promise<Muid>
a promise that resolves to the address of the newly created entry
- Defined in implementation/Box.ts:46

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>
checks to see how many things are in the box (will be either 0 or 1)
Parameters
- OptionalasOf: AsOf
  Historical time to look
Returns Promise<number>
0 or 1 depending on whether there's something in the box.
Overrides Container.size
- Defined in implementation/Box.ts:68

toJson

toJson(
    indent?: number | boolean,
    asOf?: AsOf,
    seen?: Set<string>,
): Promise<string>
Generates a JSON representation of the data in the box (the box itself is transparent). 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! Prevent cycles from breaking things)
Returns Promise<string>
a JSON string
Overrides Container.toJson
- Defined in implementation/Box.ts:129

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

`Static`get

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

Class Box

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

get

Parameters

Returns Promise<Value | Container>

getName

Parameters

Returns Promise<string>

isEmpty

Parameters

Returns Promise<boolean>

reset

Parameters

Returns Promise<void>

Argument

Argument

Argument

resetProperties

Parameters

Returns Promise<void>

set

Parameters

Returns Promise<Muid>

setName

Parameters

Returns Promise<Muid>

size

Parameters

Returns Promise<number>

toJson

Parameters

Returns Promise<string>

whatAmI

Returns string

Protected StaticaddContainer

Parameters

Returns Promise<Muid>

Staticcreate

Parameters

Returns Promise<Box>

Staticget

Parameters

Returns Box

Settings

On This Page

`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