Interface ICollaboratorMap

Interface for an IObservableMap that tracks collaborators.

Hierarchy

Properties

A signal emitted when the map has changed.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

localCollaborator: ICollaborator

The local collaborator on a model.

size: number

The number of key-value pairs in the map.

type: "Map"

The type of the Observable.

Methods

  • Set the ObservableMap to an empty map.

    Returns void

  • Remove a key from the map

    Parameters

    • key: string

      the key to remove.

    Returns ICollaborator

    the value of the given key, or undefined if that does not exist.

  • Dispose of the resources held by the map.

    Returns void

  • Get a value for a given key.

    Parameters

    • key: string

      the key.

    Returns ICollaborator

    the value for that key.

  • Check whether the map has a key.

    Parameters

    • key: string

      the key to check.

    Returns boolean

    true if the map has the key, false otherwise.

  • Get a list of the keys in the map.

    Returns string[]

    • a list of keys.
  • Set a key-value pair in the map

    Parameters

    • key: string

      The key to set.

    • value: ICollaborator

      The value for the key.

    Returns ICollaborator

    the old value for the key, or undefined if that did not exist.

Generated using TypeDoc