Interface AttributesGroupModel<T>

DOT object with the property that attributes can be held as a set of keys and values.

interface AttributesGroupModel<T> {
    comment?: string;
    size: number;
    values: readonly [T, Attribute<T>][];
    apply(attributes): void;
    clear(): void;
    delete(key): void;
    get<K>(key): undefined | Attribute<K>;
    set<K>(key, value): void;
}

Type Parameters

  • T extends AttributeKey

    The attribute keys to set DOT object.

Hierarchy (view full)

Implemented by

Properties

comment? size values

Methods

apply clear delete get set

Properties

Optional comment

comment?: string

Comments to include when outputting with toDot.

Readonly size

size: number

Size of the set of keys and values held by the DOT object.

Readonly values

values: readonly [T, Attribute<T>][]

The key/value tuples of the object attributes.

Methods

apply

  • apply(attributes): void

  • Apply keys and values that can be specified for DOT objects collectively.

    Parameters

    Returns void

clear

  • clear(): void

  • Delete all attributes specified for the DOT object.

    Returns void

delete

  • delete(key): void

  • Delete the value of an attribute from a DOT object by specifying a key.

    Parameters

    • key: T

    Returns void

get

  • get<K>(key): undefined | Attribute<K>

  • Get the value of an attribute by a DOT object by specifying its key.

    If the value corresponding to the key does not exist, undefined is returned.

    Type Parameters

    Parameters

    • key: K

    Returns undefined | Attribute<K>

set

  • set<K>(key, value): void

  • Set a value, by specifying the key of the attributes in the DOT object.

    Type Parameters

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

commentsizevaluesapplycleardeletegetset

Generated using TypeDoc