# @types/object-keys-mapping

> TypeScript definitions for object-keys-mapping

Latest version **3.0.4** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/object-keys-mapping
pnpm add @types/object-keys-mapping
yarn add @types/object-keys-mapping
bun add @types/object-keys-mapping
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.4 |
| Published | 2023-11-21 |
| First published | 2018-09-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/object-keys-mapping
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-keys-mapping
- npm.io page: https://npm.io/package/@types/object-keys-mapping

## Recent versions

- 3.0.4 (latest) — 2023-11-21
- 3.0.1 (ts3.6) — 2021-07-08
- 3.0.0 (ts2.2) — 2018-09-11
- 3.0.3 — 2023-11-07
- 3.0.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/object-keys-mapping`

# Summary
This package contains type definitions for object-keys-mapping (https://github.com/coderhaoxin/object-keys-mapping#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-keys-mapping.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-keys-mapping/index.d.ts)
````ts
export function trim(origin: object, ignore?: (v: any) => boolean): object;
export function trim(origin: readonly object[], ignore?: (v: any) => boolean): object[];

export function toCamelcase(origin: object): object;
export function toCamelcase(origin: readonly object[]): object[];

export function reverseCamelcase(origin: object): object;
export function reverseCamelcase(origin: readonly object[]): object[];

export interface OperatorOptions {
    camelcase?: boolean | undefined;
    mapping?: object | undefined;
}

export class Operator {
    constructor(opts?: { camelcase?: boolean | undefined });

    map(origin: object): object;
    map(origin: readonly object[]): object[];

    mapField(path: string): string;

    mapObject(origin: object, path: string): object;

    mapArray(origin: readonly object[]): object[];
}

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

# Credits
These definitions were written by [newraina](https://github.com/newraina).

---
_Source: https://npm.io/package/@types/object-keys-mapping · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._