# deep-object-rename

> A Javascript library for deep object renaming by key or value, written in TypeScript

Latest version **2.0.0** (published 2026-08-23) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install deep-object-rename
pnpm add deep-object-rename
yarn add deep-object-rename
bun add deep-object-rename
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-08-23 |
| First published | 2020-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=24 |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Rick Waterman |
| Maintainers | rwaterman |
| Keywords | TypeScript, Object, Deep Rename |

## Links

- npm: https://www.npmjs.com/package/deep-object-rename
- Repository: https://github.com/rwaterman/deep-object-rename
- Homepage: https://github.com/rwaterman/deep-object-rename#readme
- Issues: https://github.com/rwaterman/deep-object-rename/issues
- npm.io page: https://npm.io/package/deep-object-rename

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2026-08-23
- 1.0.0 — 2020-08-13

## README

# deep-object-rename

Zero-dependency helper to deeply rename either (1) object keys or (2) object values.

ESM only. Requires Node.js 24+.

```sh
npm install deep-object-rename
```

## renameKeys

Pass a function that returns the new key, or the `SkipRename` symbol to leave it as is.

```ts
import { renameKeys, SkipRename } from 'deep-object-rename';

const obj = { x: { y: { z: 123 } } };

const changed = renameKeys(obj, (key) => (key.startsWith('y') ? 'y_changed' : SkipRename));
// { x: { y_changed: { z: 123 } } }
```

## renameValues

Pass a function that returns the new value, or the `SkipRename` symbol to leave it as is. Only primitive values (`string | number | boolean | null | undefined`, see `DeepRenameValue`) are passed to the callback; nested objects are traversed, arrays are returned untouched.

```ts
import { renameValues, SkipRename, type DeepRenameValue } from 'deep-object-rename';

const obj = { x: { y: { y: 123, z: '123' }, x2: '123' } };

const changed = renameValues(obj, (val: DeepRenameValue) => (val === '123' ? 123 : SkipRename));
// { x: { y: { y: 123, z: 123 }, x2: 123 } }
```

## Development

```sh
npm test        # node:test
npm run lint    # eslint
npm run build   # tsc -> lib/*.mjs
```

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