Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICollaboratorMap

Interface for an IObservableMap that tracks collaborators.

Hierarchy

Index

Properties

Readonly changed

A signal emitted when the map has changed.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly localCollaborator

localCollaborator: ICollaborator

The local collaborator on a model.

Readonly size

size: number

The number of key-value pairs in the map.

type

type: "Map"

The type of the Observable.

Methods

clear

  • clear(): void
  • Set the ObservableMap to an empty map.

    Returns void

delete

  • 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

  • dispose(): void
  • Dispose of the resources held by the map.

    Returns void

get

  • Get a value for a given key.

    Parameters

    • key: string

      the key.

    Returns ICollaborator

    the value for that key.

has

  • has(key: string): boolean
  • 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.

keys

  • keys(): string[]
  • Get a list of the keys in the map.

    Returns string[]

    • a list of keys.

set

  • 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.

values

  • Get a list of the values in the map.

    Returns ICollaborator[]

    • a list of values.

Generated using TypeDoc