githubmirror/immutable-js

website/docs/remove().mdx

20 строк584 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';

# remove()

Returns a copy of the collection with the value at key removed.

<Signature code={`remove(collection: C, key): C;`} />

A functional alternative to `collection.remove(key)` which will also work with plain Objects and Arrays as an alternative for `delete collectionCopy[key]`.

<Repl
  defaultValue={`const originalList = List([ 'dog', 'frog', 'cat' ])
remove(originalList, 1)`}
/>

<Repl
  defaultValue={`const originalObject = { x: 123, y: 456 }
remove(originalObject, 'x') `}
/>