index.md

$unshift migration

Adds items to the beginning of iterables in subject addressed by path

Signature

path (String/Array) - The path to the iterable to add a new item to

value Any - The new item

subject (Object) - The object that contains the iterable

TYPE SIGNATURES

String -> * -> Object -> Object
(String, *) -> Object -> Object
(String, *,  Object) -> Object
Array -> * -> Object -> Object
(Array, *) -> Object -> Object
(Array, *,  Object) -> Object

EXAMPLE

const myObject = {
    itemsInTheFrige: ['eggs', 'beer', 'milk']
};

$unshift('itemsInTheFrige', 'wine', myObject);

// returns { itemsInTheFrige: ['wine', 'eggs', 'beer', 'milk'] }

IMMUTABLE JS SUPPORT (DEPRECATED)

WARNING: Immutable JS support is deprecated. It will be removed entirely with the next major version of Plow JS (which will be 4.0.0). Until then, support for Immutable JS versions below (but not including) v4 - though discouraged - continues to work.

the following types are supported for values targeted by path:

Stack
Map
OrderedSet
Set
OrderedMap
List