githubmirror/immutable-js

src/predicates/isKeyed.ts

26 строк764 B

Julien Deniau

import comments into TS files

23 фев 2025, 22:59

23 фев 2025, 22:59c16cbcf

import type { Collection } from '../../type-definitions/immutable';

export const IS_KEYED_SYMBOL = '@@__IMMUTABLE_KEYED__@@';

/**
 * True if `maybeKeyed` is a Collection.Keyed, or any of its subclasses.
 *
 * ```js
 * import { isKeyed, Map, List, Stack } from 'immutable';
 *
 * isKeyed([]); // false
 * isKeyed({}); // false
 * isKeyed(Map()); // true
 * isKeyed(List()); // false
 * isKeyed(Stack()); // false
 * ```
 */
export function isKeyed(
  maybeKeyed: unknown
): maybeKeyed is Collection.Keyed<unknown, unknown> {
  return Boolean(
    maybeKeyed &&
      // @ts-expect-error: maybeKeyed is typed as `{}`, need to change in 6.0 to `maybeKeyed && typeof maybeKeyed === 'object' && IS_KEYED_SYMBOL in maybeKeyed`
      maybeKeyed[IS_KEYED_SYMBOL]
  );
}