githubmirror/immutable-js

src/predicates/isImmutable.ts

24 строки794 B

Julien Deniau

import comments into TS files

23 фев 2025, 22:59

23 фев 2025, 22:59c16cbcf

import type { Collection, Record } from '../../type-definitions/immutable';
import { isCollection } from './isCollection';
import { isRecord } from './isRecord';

/**
 * True if `maybeImmutable` is an Immutable Collection or Record.
 *
 * Note: Still returns true even if the collections is within a `withMutations()`.
 *
 * ```js
 * import { isImmutable, Map, List, Stack } from 'immutable';
 * isImmutable([]); // false
 * isImmutable({}); // false
 * isImmutable(Map()); // true
 * isImmutable(List()); // true
 * isImmutable(Stack()); // true
 * isImmutable(Map().asMutable()); // true
 * ```
 */
export function isImmutable(
  maybeImmutable: unknown
): maybeImmutable is Collection<unknown, unknown> | Record<object> {
  return isCollection(maybeImmutable) || isRecord(maybeImmutable);
}