MutableMap

:::info[Note] This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information. :::

Represents a write-enabled (mutable) sequence of key/value pairs (i.e. a map)

Guides

• Introduction
• Interfaces

Interface Synopsis

interface MutableMap implements ConstMap<Tk, Tv>, HH\Collection<Pair<Tk, Tv>>, MapAccess<Tk, Tv> {...}

Public Methods

• ->concat<Tu super Tv>(Traversable<Tu> $traversable): MutableVector<Tu>
  Returns a MutableVector that is the concatenation of the values of the current MutableMap and the values of the provided Traversable
• ->filter((function(Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values of the current MutableMap that meet a supplied condition
• ->filterWithKey((function(Tk, Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values of the current MutableMap that meet a supplied condition applied to its keys and values
• ->firstKey(): ?Tk
  Returns the first key in the current MutableMap
• ->firstValue(): ?Tv
  Returns the first value in the current MutableMap
• ->keys(): MutableVector<Tk>
  Returns a MutableVector containing the keys of the current MutableMap
• ->lastKey(): ?Tk
  Returns the last key in the current MutableMap
• ->lastValue(): ?Tv
  Returns the last value in the current MutableMap
• ->map<Tu>((function(Tv): Tu) $fn): MutableMap<Tk, Tu>
  Returns a MutableMap after an operation has been applied to each value in the current MutableMap
• ->mapWithKey<Tu>((function(Tk, Tv): Tu) $fn): MutableMap<Tk, Tu>
  Returns a MutableMap after an operation has been applied to each key and value in the current MutableMap
• ->skip(int $n): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values after the n-th element of the current MutableMap
• ->skipWhile((function(Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values of the current MutableMap starting after and including the first value that produces true when passed to the specified callback
• ->slice(int $start, int $len): MutableMap<Tk, Tv>
  Returns a subset of the current MutableMap starting from a given key location up to, but not including, the element at the provided length from the starting key location
• ->take(int $n): MutableMap<Tk, Tv>
  Returns a MutableMap containing the first n key/values of the current MutableMap
• ->takeWhile((function(Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the keys and values of the current MutableMap up to but not including the first value that produces false when passed to the specified callback
• ->toDArray(): darray<Tk, Tv>
• ->toVArray(): varray<Tv>
• ->values(): MutableVector<Tv>
  Returns a MutableVector containing the values of the current MutableMap
• ->zip<Tu>(Traversable<Tu> $traversable): MutableMap<Tk, Pair<Tv, Tu>>
  Returns a MutableMap where each value is a Pair that combines the value of the current MutableMap and the provided Traversable

Public Methods (ConstCollection)

• ->count(): int
  Get the number of items in the collection

• ->isEmpty(): bool
  Is the collection empty?

• ->items(): HH\Iterable<Te>
  Get access to the items in the collection

Public Methods (IPureStringishObject)

• ->__toString(): string

Public Methods (ConstSetAccess)

• ->contains(arraykey $m): bool
  Checks whether a value is in the current Set

Public Methods (ConstIndexAccess)

• ->at(Tk $k): Tv
  Returns the value at the specified key in the current collection
• ->containsKey(mixed $k): bool
  Determines if the specified key is in the current collection
• ->get(Tk $k): ?Tv
  Returns the value at the specified key in the current collection

Public Methods (HH\KeyedIterable)

• ->getIterator(): KeyedIterator<Tk, Tv>
  Returns an iterator that points to beginning of the current KeyedIterable
• ->lazy(): KeyedIterable<Tk, Tv>
  Returns a lazy, access elements only when needed view of the current KeyedIterable
• ->toImmMap(): ImmMap<Tk, Tv>
  Returns an immutable map (ImmMap) based on the keys and values of the current KeyedIterable
• ->toKeysArray(): varray
  Returns an array with the keys from the current KeyedIterable

Public Methods (HH\Iterable)

• ->toImmSet(): ImmSet<Tv>
  Returns an immutable set (ImmSet) converted from the current Iterable
• ->toImmVector(): ImmVector<Tv>
  Returns an immutable vector (ImmVector) converted from the current Iterable
• ->toValuesArray(): varray<Tv>
  Returns an array with the values from the current Iterable

Public Methods (HH\Collection)

• ->clear()
  Removes all items from the collection

Public Methods (OutputCollection)

• ->add(Te $e): this
  Add a value to the collection and return the collection itself
• ->addAll(?Traversable<Te> $traversable): this
  For every element in the provided Traversable, append a value into the current collection

Public Methods (SetAccess)

• ->remove(Tm $m): this
  Removes the provided value from the current Set

Public Methods (IndexAccess)

• ->removeKey(Tk $k): this
  Removes the specified key (and associated value) from the current collection
• ->set(Tk $k, Tv $v): this
  Stores a value into the current collection with the specified key, overwriting the previous value associated with the key
• ->setAll(?KeyedTraversable<Tk, Tv> $traversable): this
  For every element in the provided Traversable, stores a value into the current collection associated with each key, overwriting the previous value associated with the key