Skip to content

docs(readme): grammar fixes #57

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
Fdawgs merged 1 commit into from
Jan 3, 2025
Merged

docs(readme): grammar fixes #57

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ The module exports a function, which provides a function to deepmerge Objects.
deepmerge(options)
```

`options` is optional and can contain following values
`options` is optional and can contain the following values:

- `symbols` (`boolean`, optional) - should also merge object-keys which are symbols, default is false
- `symbols` (`boolean`, optional) - should also merge object keys that are symbols, default is false
- `all` (`boolean`, optional) - makes deepmerge accept and merge any number of passed objects, default is false
- `mergeArray` (`function`, optional) - provide a function, which returns a function to add custom array merging function
- `cloneProtoObject` (`function`, optional) - provide a function, which must return a clone of the object with the prototype of the object
Expand Down Expand Up @@ -133,7 +133,7 @@ console.log(result) // { stream: <ref *1> WriteStream }

## Benchmarks

The benchmarks are available in the benchmark-folder.
The benchmarks are available in the benchmark folder.

`npm run bench` - benchmark various use cases of deepmerge:
```
Expand Down