isOrdered()

True if maybeOrdered is a Collection where iteration order is well defined. True for Collection.Indexed as well as OrderedMap and OrderedSet.

Method signature

isOrdered(maybeOrdered: unknown): boolean;
import { isOrdered, Map, OrderedMap, List, Set } from 'immutable';

isOrdered([]); // false
isOrdered({}); // false
isOrdered(Map()); // false
isOrdered(OrderedMap()); // true
isOrdered(List()); // true
isOrdered(Set()); // false
;