Class Sequence

Kind of like the Gink version of a Javascript Array; supports push, pop, shift. Doesn't support unshift because order is defined by insertion order.

Hierarchy (View Summary)

Container
- Sequence

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

at

at(position: number, asOf?: AsOf): Promise<Value | Container>
Parameters
- position: number
  Index to look for the thing, negative counts from end, or muid of entry
- OptionalasOf: AsOf
Returns Promise<Value | Container>
value at the position of the list, or undefined if list is too small
- Defined in implementation/Sequence.ts:317

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

entries

entries(
through?: number,
asOf?: AsOf,
): AsyncGenerator<[Muid, Value | Container], void>
Function to iterate over the contents of the List, showing the address of each entry (which can be used in pop).
Parameters
- through: number = Infinity
  count of many things to iterate through, positive starting from front, negative for end
- OptionalasOf: AsOf
  effective time to get the contents for
Returns AsyncGenerator<[Muid, Value | Container], void>
an async iterator across everything in the list, with values returned being pairs of Muid, (Value|Container),
- Defined in implementation/Sequence.ts:370

equals

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

extend

extend(iterable: Iterable<Value | Container>, meta?: Meta): Promise<void>
Adds multiple entries into this sequence. NOTE: If you pass a bundler, all changes will share the same timestamp. This means you will not be able to move new entries in between these (you may move these entries between one another). Without a bundler, each item from the iterable will be committed separately, which will be costly, but there won't be the same restrictions on moving.
Parameters
- iterable: Iterable<Value | Container>
  An iterable of stuff to add to the sequence.
- Optionalmeta: Meta
  optional place to pass in a comment or bundler
Returns Promise<void>
- Defined in implementation/Sequence.ts:280

getName

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

move

move(
    what: number | Muid,
    dest: number,
    purge?: boolean,
    meta?: Meta,
): Promise<void>
Parameters
- what: number | Muid
- dest: number
- Optionalpurge: boolean
- Optionalmeta: Meta
Returns Promise<void>
- Defined in implementation/Sequence.ts:58

pop

pop(
    what?: number | Muid,
    purge?: boolean,
    meta?: Meta,
): Promise<Value | Container>
Parameters
- Optionalwhat: number | Muid
- Optionalpurge: boolean
- Optionalmeta: Meta
Returns Promise<Value | Container>
- Defined in implementation/Sequence.ts:221

push

push(value: Value | Container, meta?: Meta): Promise<Muid>
Adds an element to the end of the list.
Parameters
- value: Value | Container
- Optionalmeta: Meta
Returns Promise<Muid>
- Defined in implementation/Sequence.ts:54

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/Sequence.ts:92

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

shift

shift(purge?: boolean, meta?: Meta): Promise<Value | Container>
Alias for this.pop with position of 0
Parameters
- Optionalpurge: boolean
- Optionalmeta: Meta
Returns Promise<Value | Container>
- Defined in implementation/Sequence.ts:264

size

size(asOf?: AsOf): Promise<number>
Parameters
- OptionalasOf: AsOf
Returns Promise<number>
Overrides Container.size
- Defined in implementation/Sequence.ts:355

toArray

toArray(through?: number, asOf?: AsOf): Promise<(Value | Container)[]>
Dumps the contents of this list to a javascript array. useful for debugging and could also be used to export data by walking the tree
Parameters
- through: number = Infinity
  how many elements to get, positive starting from beginning, negative starting from end
- OptionalasOf: AsOf
  effective time to get the dump for: leave undefined to get data as of the present
Returns Promise<(Value | Container)[]>
an array containing Values (e.g. numbers, strings) and Containers (e.g. other Lists, Boxes, Directories)
- Defined in implementation/Sequence.ts:335

toJson

toJson(
    indent?: number | boolean,
    asOf?: AsOf,
    seen?: Set<string>,
): Promise<string>
Generates a JSON representation of the data in the list. 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/Sequence.ts:399

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

`Static`get

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

Class Sequence

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>

at

Parameters

Returns Promise<Value | Container>

clear

Parameters

Returns Promise<Muid>

entries

Parameters

Returns AsyncGenerator<[Muid, Value | Container], void>

equals

Parameters

Returns boolean

extend

Parameters

Returns Promise<void>

getName

Parameters

Returns Promise<string>

move

Parameters

Returns Promise<void>

pop

Parameters

Returns Promise<Value | Container>

push

Parameters

Returns Promise<Muid>

reset

Parameters

Returns Promise<void>

Argument

Argument

Argument

resetProperties

Parameters

Returns Promise<void>

setName

Parameters

Returns Promise<Muid>

shift

Parameters

Returns Promise<Value | Container>

size

Parameters

Returns Promise<number>

toArray

Parameters

Returns Promise<(Value | Container)[]>

toJson

Parameters

Returns Promise<string>

whatAmI

Returns string

`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