Skip to content

Commit fa618b2

Browse files
authored
docs(readme): grammar fixes (#163)
Signed-off-by: Frazer Smith <[email protected]>
1 parent 5ad5a09 commit fa618b2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In addition to providing header manipulation, the plugin also decorates the
1616
server instance with an object that can be used for caching items. **Note:**
1717
the default cache should not be used in a "production" environment. It is
1818
an LRU, in-memory cache that is capped at 100,000 items. It is *highly*
19-
recommended that a full featured cache object be supplied, e.g.
19+
recommended that a full-featured cache object be supplied, e.g.
2020
[abstract-cache-redis][acache-redis].
2121

2222
[acache-redis]: https://www.npmjs.com/package/abstract-cache-redis
@@ -42,7 +42,7 @@ See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Ref
4242

4343
## Example
4444

45-
This example shows using the plugin to disable client side caching of all
45+
This example shows using the plugin to disable client-side caching of all
4646
routes.
4747

4848
```js
@@ -123,7 +123,7 @@ for a *cache-response-directive* as defined by RFC 2616.
123123
resource may be cached. When this is set, and `privacy` is not set to `no-cache`,
124124
then `', max-age=<value>'` will be appended to the `cache-control` header.
125125
+ `cache` (Default: `abstract-cache.memclient`): an [abstract-cache][acache]
126-
protocol compliant cache object. Note: the plugin requires a cache instance to
126+
protocol-compliant cache object. Note: the plugin requires a cache instance to
127127
properly support the ETag mechanism. Therefore, if a falsy value is supplied
128128
the default will be used.
129129
+ `cacheSegment` (Default: `'@fastify/caching'`): segment identifier to use when
@@ -144,7 +144,7 @@ recommended to always supply a value to this method to avoid this operation.
144144
All incoming requests to paths affected by this plugin will be inspected for
145145
the `if-none-match` header. If the header is present, the value will be used
146146
to lookup the tag within the cache associated with this plugin. If the tag is
147-
found, then the response will be ended with a 304 status code sent to
147+
found, then the response will end with a 304 status code sent to
148148
the client.
149149

150150
Tags will be cached according to the second parameter. If the second parameter
@@ -158,7 +158,7 @@ milliseconds. The default lifetime, when the parameter is not specified, is
158158
### `reply.expires(date)`
159159

160160
This method allows setting of the `expires` header. It accepts a regular `Date`
161-
object, or a string that is a valid date string according to
161+
object or a string that is a valid date string according to
162162
[RFC 2616 §14.21][sec14.21].
163163

164164
[sec14.21]: https://tools.ietf.org/html/rfc2616#section-14.21

0 commit comments

Comments
 (0)