githubmirror/immutable-js

website/docs/getIn().mdx

15 строк570 B

Julien Deniau

Doc as mdx instead of export from .d.ts file (#2104)

24 май 2025, 00:47

24 май 2025, 00:4721de701

import Repl from '@/repl/Repl.tsx';
import CodeLink from '@/mdx-components/CodeLink.tsx';

# getIn()

Returns the value at the provided key path starting at the provided collection, or notSetValue if the key path is not defined.

A functional alternative to `collection.getIn(keypath)` which will also work with plain Objects and Arrays.

<Signature code={`getIn(collection, keyPath, notSetValue?): any;`} />

<Repl defaultValue={`getIn({ x: { y: { z: 123 }}}, ['x', 'y', 'z'])`} />
<Repl
  defaultValue={`getIn({ x: { y: { z: 123 }}}, ['x', 'q', 'p'], 'ifNotSet')`}
/>