Skip to content

Commit 1adc926

Browse files
authored
docs(readme): spelling and grammar fixes (#756)
Signed-off-by: Frazer Smith <frazer.dev@icloud.com>
1 parent 7480aa3 commit 1adc926

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ compile-json-stringify date format x 1,125,735 ops/sec ±0.19% (98 runs sampled)
7070
- <a href="#security">`Security Notice`</a>
7171
- <a href="#debug">`Debug Mode`</a>
7272
- <a href="#standalone">`Standalone Mode`</a>
73-
- <a href="#acknowledgements">`Acknowledgements`</a>
73+
- <a href="#acknowledgments">`Acknowledgments`</a>
7474
- <a href="#license">`License`</a>
7575

7676

@@ -111,7 +111,7 @@ console.log(stringify({
111111
<a name="options"></a>
112112
## Options
113113

114-
Optionally, you may provide to `fast-json-stringify` an option object as second parameter:
114+
Optionally, you may provide to `fast-json-stringify` an option object as the second parameter:
115115

116116
```js
117117
const fastJson = require('fast-json-stringify')
@@ -165,7 +165,7 @@ And nested ones, too.
165165
| `date` | `2020-04-03` |
166166
| `time` | `09:11:08` |
167167

168-
**Note**: In the case of string formatted Date and not Date Object, there will be no manipulation on it. It should be properly formatted.
168+
**Note**: In the case of a string formatted Date and not Date Object, there will be no manipulation on it. It should be properly formatted.
169169

170170
Example with a Date object:
171171

@@ -290,7 +290,7 @@ console.log(stringify(obj)) // '{"matchfoo":"42","otherfoo":"str","matchnum":3,"
290290
*additionalProperties* must be an object or a boolean, declared in this way: `{ type: 'type' }`.
291291
*additionalProperties* will work only for the properties that are not explicitly listed in the *properties* and *patternProperties* objects.
292292

293-
If *additionalProperties* is not present or is set to `false`, every property that is not explicitly listed in the *properties* and *patternProperties* objects,will be ignored, as described in <a href="#missingFields">Missing fields</a>.
293+
If *additionalProperties* is not present or is set to `false`, every property that is not explicitly listed in the *properties* and *patternProperties* objects will be ignored, as described in <a href="#missingFields">Missing fields</a>.
294294
Missing fields are ignored to avoid having to rewrite objects before serializing. However, other schema rules would throw in similar situations.
295295
If *additionalProperties* is set to `true`, it will be used by `JSON.stringify` to stringify the additional properties. If you want to achieve maximum performance, we strongly encourage you to use a fixed schema where possible.
296296
The additional properties will always be serialized at the end of the object.
@@ -543,12 +543,12 @@ const stringify = fastJson(schema, { schema: externalSchema })
543543

544544
<a name="long"></a>
545545
#### Long integers
546-
By default the library will handle automatically [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt).
546+
By default, the library will handle automatically [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt).
547547

548548
<a name="integer"></a>
549549
#### Integers
550550
The `type: integer` property will be truncated if a floating point is provided.
551-
You can customize this behaviour with the `rounding` option that will accept [`round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round), [`ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil), [`floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor) or [`trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc). Default is `trunc`:
551+
You can customize this behavior with the `rounding` option that will accept [`round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round), [`ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil), [`floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor), or [`trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc). Default is `trunc`:
552552

553553
```js
554554
const stringify = fastJson(schema, { rounding: 'ceil' })
@@ -650,8 +650,8 @@ const stringify = fastJson({
650650

651651
##### Benchmarks
652652

653-
For reference, here goes some benchmarks for comparison over the three
654-
mechanisms. Benchmarks conducted on an old machine.
653+
For reference, here are some benchmarks for comparison over the three
654+
mechanisms. Benchmarks were conducted on an old machine.
655655

656656
- Machine: `ST1000LM024 HN-M 1TB HDD, Intel Core i7-3610QM @ 2.3GHz, 12GB RAM, 4C/8T`.
657657
- Node.js `v16.13.1`
@@ -728,12 +728,12 @@ const stringify = require('stringify.js')
728728
console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"Foo"}'
729729
```
730730

731-
<a name="acknowledgements"></a>
732-
## Acknowledgements
731+
<a name="acknowledgments"></a>
732+
## Acknowledgments
733733

734734
This project was kindly sponsored by [nearForm](https://nearform.com).
735735

736736
<a name="license"></a>
737737
## License
738738

739-
MIT
739+
Licensed under [MIT](./LICENSE).

0 commit comments

Comments
 (0)