Function remove

src/functional/remove.ts:36–71

(
  collection:
    | Collection<K, unknown>
    | Array<unknown>
    | { [key: PropertyKey]: unknown },
  key: K
)

    | { [key: PropertyKey]: unknown },
>(collection: C, key: K): C;
export function remove<K>(
  collection:
    | Collection<K, unknown>
    | Array<unknown>
    | { [key: PropertyKey]: unknown },
  key: K
) {
  if (!isDataStructure(collection)) {
    throw new TypeError(
      'Cannot update non-data-structure value: ' + collection
    );
  }
  if (isImmutable(collection)) {
    // @ts-expect-error weird "remove" here,
    if (!collection.remove) {
      throw new TypeError(
        'Cannot update immutable value without .remove() method: ' + collection
      );
    }
    // @ts-expect-error weird "remove" here,
    return collection.remove(key);
  }
  // @ts-expect-error assert that key is a string, a number or a symbol here
  if (!hasOwnProperty.call(collection, key)) {
    return collection;
  }
  const collectionCopy = shallowCopy(collection);
  if (Array.isArray(collectionCopy)) {
    // @ts-expect-error assert that key is a number here
    collectionCopy.splice(key, 1);
  } else {
    // @ts-expect-error assert that key is a string, a number or a symbol here
    delete collectionCopy[key];
  }
  return collectionCopy;
}