Class QidMap<V>

QidMap represents a Set of mappings from Qid to some other object. It is like JavaScript Map, but specifically for keys of the Qid

Type Parameters

  • V

Constructors

constructor

Accessors

keys size

Methods

[iterator] clear delete entries forEach get getByVidOid has set setByVidOid values

Constructors

constructor

Accessors

keys

size

Methods

[iterator]

clear

  • clear(): void

  • The clear() method of QidMap instances removes all Qid mappings from this map.

    Returns void

delete

  • delete(qid): boolean

  • The delete() method of QidMap instances removes the specified Qid mapping from this map by qid.

    Parameters

    Returns boolean

entries

forEach

  • forEach(callbackFn, thisArg?): void

  • Parameters

    • callbackFn: ((qid: Qid) => boolean)
        • (qid): boolean

        • Parameters

          Returns boolean

    • OptionalthisArg: unknown

    Returns void

get

  • get(qid): V

  • Parameters

    • qid: Qid

      The Qid to get the value for

    Returns V

    The linked object or null when there is no mapping for the Qid

getByVidOid

has

  • has(qid): boolean

  • The has() method of QidMap instances returns a boolean indicating whether an element with the specified qid exists in this map or not.

    Parameters

    Returns boolean

set

  • set(qid, value): boolean

  • The set() method of QidMap instances adds or updates an entry in this map with a specified Qid and a value.

    Parameters

    • qid: Qid

      The Qid for which to set the value

    • value: V

      The value to set

    Returns boolean

setByVidOid

  • setByVidOid(vid, oid, value): boolean

  • The setByVidOid() method of QidMap instances adds or updates an entry in this map with a specified Qid (given as Vid + Oid) and a value. This method should only be used when no Qid is available, and in those cases it will be slighly faster than first creating a Qid

    Parameters

    • vid: string

      The Vid for which to set the value

    • oid: number

      The Oid for which to set the value

    • value: V

      The value to set

    Returns boolean

values

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods