Class Accumulator

Hierarchy (View Summary)

Container
- Accumulator

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

addBillionths

addBillionths(value: bigint, meta?: Meta): Promise<Muid>
Parameters
- value: bigint
- Optionalmeta: Meta
Returns Promise<Muid>
- Defined in implementation/Accumulator.ts:57

`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

addNumber

addNumber(increment: number, meta?: Meta): Promise<Muid>
Parameters
- increment: number
- Optionalmeta: Meta
Returns Promise<Muid>
- Defined in implementation/Accumulator.ts:40

clear

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

equals

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

getBillionths

getBillionths(asOf?: AsOf): Promise<bigint>
Parameters
- OptionalasOf: AsOf
Returns Promise<bigint>
- Defined in implementation/Accumulator.ts:53

getName

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

getNumber

getNumber(asOf?: AsOf): Promise<number>
Parameters
- OptionalasOf: AsOf
Returns Promise<number>
- Defined in implementation/Accumulator.ts:45

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
- Optional_recurse: 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/Accumulator.ts:69

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>
Parameters
- Optional_asOf: AsOf
Returns Promise<number>
Overrides Container.size
- Defined in implementation/Accumulator.ts:61

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
- OptionalasOf: AsOf
  effective time
- Optional_seen: Set<string>
Returns Promise<string>
a JSON string
Overrides Container.toJson
- Defined in implementation/Accumulator.ts:86

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

`Static`get

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

Class Accumulator

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

addBillionths

Parameters

Returns Promise<Muid>

ProtectedaddEntry

Parameters

Returns Promise<Muid>

addNumber

Parameters

Returns Promise<Muid>

clear

Parameters

Returns Promise<Muid>

equals

Parameters

Returns boolean

getBillionths

Parameters

Returns Promise<bigint>

getName

Parameters

Returns Promise<string>

getNumber

Parameters

Returns Promise<number>

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>

whatAmI

Returns string

Protected StaticaddContainer

Parameters

Returns Promise<Muid>

Staticcreate

Parameters

Returns Promise<Accumulator>

Staticget

Parameters

Returns Accumulator

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