Interface iMapDoc<T>

interface iMapDoc<T> {
    _docId: string;
    _id?: string;
    creator: string;
    defaultValue: string;
    inheritManagerTimelineFrom: T;
    managerTimeline: iManagerTimeline<T>[];
    mapId: string;
    metadata?: iMetadata<T>;
    metadataTimeline: iMapMetadataTimeline<T>[];
    permissions: iMapPermissions<T>;
    updateCriteria: iMapUpdateCriteria<T>;
    updateHistory: iUpdateHistory<T>[];
    valueOptions: iValueOptions;
    values: {
        [key: string]: iValueStore;
    };
}

Type Parameters

T extends NumberType

Hierarchy (view full)

Doc
iMapWithValues<T>
- iMapDoc

Implemented by

MapDoc

Index

Properties

_docId _id? creator defaultValue inheritManagerTimelineFrom managerTimeline mapId metadata? metadataTimeline permissions updateCriteria updateHistory valueOptions values

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

creator

creator: string

defaultValue

defaultValue: string

inheritManagerTimelineFrom

inheritManagerTimelineFrom: T

managerTimeline

managerTimeline: iManagerTimeline<T>[]

mapId

mapId: string

`Optional`metadata

metadata?: iMetadata<T>

The fetched metadata for the map (if any).

metadataTimeline

metadataTimeline: iMapMetadataTimeline<T>[]

permissions

permissions: iMapPermissions<T>

updateCriteria

updateCriteria: iMapUpdateCriteria<T>

updateHistory

updateHistory: iUpdateHistory<T>[]

The update history for the map. Maps are maintained through blockchain transactions.

valueOptions

valueOptions: iValueOptions

values

values: {
[key: string]: iValueStore;
}

The (key, value) pairs for the maps that are set.