Class EdgeType

Hierarchy (View Summary)

Container
- EdgeType

Index

Properties

address behavior database DELETION globalPropertyMuid INCLUSION

Accessors

Methods

[inspectSymbol] addEntry clear create equals getName reset resetProperties 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

create

create(
    source: Vertex,
    target: Vertex,
    value?: Value,
    meta?: Meta,
): Promise<Edge>
Parameters
- source: Vertex
- target: Vertex
- Optionalvalue: Value
- Optionalmeta: Meta
Returns Promise<Edge>
- Defined in implementation/EdgeType.ts:61

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

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/EdgeType.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

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>
Returns Promise<number>
Overrides Container.size
- Defined in implementation/EdgeType.ts:49

toJson

toJson(
    indent: number | boolean,
    asOf?: AsOf,
    seen?: Set<string>,
): Promise<string>
Parameters
- indent: number | boolean
- OptionalasOf: AsOf
- Optionalseen: Set<string>
Returns Promise<string>
Overrides Container.toJson
- Defined in implementation/EdgeType.ts:53

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

`Static`get

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

Class EdgeType

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>

create

Parameters

Returns Promise<Edge>

equals

Parameters

Returns boolean

getName

Parameters

Returns Promise<string>

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<EdgeType>

Staticget

Parameters

Returns EdgeType

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