Skip to content

add more explicit inPlace documentation #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Skn0tt merged 1 commit into from
Aug 12, 2025
Merged

add more explicit inPlace documentation #323

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,13 @@ const { json, meta } = serialize(object);
deserialize({ json, meta }, { inPlace: true });
```

Options

- `inPlace: boolean`
- Default: `false`
- Mutate the input json object in place instead of returning a deep copy
- `inPlace: true` will be much more performant on large objects if it's safe to mutate it

Returns **`your original value`**.

### stringify
Expand Down
Loading