Logo for jsDocs.io

@types/object.omit

  • Version 3.0.3
  • Published
  • 3.96 kB
  • No dependencies
  • MIT license

Install

npm i @types/object.omit
yarn add @types/object.omit
pnpm add @types/object.omit

Overview

TypeScript definitions for object.omit

Index

Functions

Functions

function omit

omit: {
    <GObject extends object, GKey extends keyof GObject>(
        object: GObject,
        key: GKey | GKey[]
    ): Omit<GObject, GKey>;
    <GObject extends object, GKey extends keyof GObject>(
        object: GObject,
        fn: (value: GObject[GKey], key: GKey, obj: GObject) => boolean
    ): { [key: string]: any };
};

  • Return a copy of an object excluding the given key, or array of keys. Also accepts an optional filter function as the last argument."

    omit({a: 'a', b: 'b', c: 'c'}, ['a', 'c'])
    //=> { b: 'b' }

    Parameter object

    Parameter keys

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/object.omit.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/object.omit)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/object.omit"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>