Skip to content

Commit f88d836

Browse files
typos
1 parent 38c8936 commit f88d836

8 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/src/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ The function used to interpret all headers from a request and determine a time t
111111

112112
::: warning
113113

114-
Many REST backends returns some variation of `Cache-Control: no-cache` or
114+
Many REST backends return some variation of `Cache-Control: no-cache` or
115115
`Cache-Control: no-store` headers, which tell us to ignore caching at all. You shall
116116
disable `headerInterpreter` for those requests.
117117

docs/src/config/request-specifics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Each request can have its own cache customization, by using the `cache` property. This
44
way, you can have requests behaving differently from each other without much effort.
55

6-
The inline documentation is self explanatory, but here is a shortly brief of what each
6+
The inline documentation is self explanatory, but here is a brief overview of what each
77
property does:
88

99
::: tip
@@ -307,7 +307,7 @@ Once the request is resolved, this specifies what other responses should change
307307
cache. Can be used to update the request or delete other caches. It is a simple `Record`
308308
with the request id.
309309

310-
Here's an example with some basic login:
310+
Here's an example with some basic logic:
311311

312312
Using a function instead of an object is supported but not recommended, as it's better to
313313
just consume the response normally and write your own code after it. But it`s here in case

docs/src/config/response-object.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Response object
22

3-
Axios cache interceptor returns a slightly changed than the original axios response.
4-
Containing information about the cache and other needed properties.
3+
Axios cache interceptor returns a slightly different response than the original axios response.
4+
It contains information about the cache and other needed properties.
55

66
## id
77

@@ -29,7 +29,7 @@ network call.
2929

3030
::: tip
3131

32-
This does not indicated if the request was capable of being cached or not, as options like
32+
This does not indicate if the request was capable of being cached or not, as options like
3333
[`cache.override`](./request-specifics.md#cache-override) may have been enabled.
3434

3535
:::

docs/src/guide.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Introduction
22

3-
Axios Cache Interceptor is a, as it name says, a interceptor for axios to handle caching.
3+
Axios Cache Interceptor is an interceptor for axios, as its name says, to handle caching.
44
It was created to help developers call axios multiple times without having to worry about
5-
overloading the network or coding himself a simple and buggy cache system.
5+
overloading the network or coding themselves a simple and buggy cache system.
66

77
Each request goes through an interceptor applied to your axios instance. There, we handle
88
each request and decide if we should send it to the network or return a cached response.
@@ -16,9 +16,9 @@ choosing to use interceptors, we create a minimally invasive approach that allow
1616
still use the axios adapter of your choice.
1717

1818
Before the request is delivered to the adapter, our request interceptor checks if the
19-
request have already been cached and if it's a valid one, checks if the request should be
20-
cached (sometimes you don't want cache at all, and it's ok), if there's already a request
21-
sent to the network that we can wait for it and many more other checks.
19+
request has already been cached and if it's valid, checks if the request should be
20+
cached (sometimes you don't want cache at all, and that's ok), if there's already a request
21+
sent to the network that we can wait for, and many other checks.
2222

2323
After the adapter gets the response, we check if it belongs to a _cacheable_ request,
2424
saves it into the storage, resolves other requests awaiting for the same resource and
@@ -41,13 +41,13 @@ finally returns the response to the original caller.
4141
### axios-cache-adapter
4242

4343
The creation of this library is heavily inspired by axios-cache-adapter. It was a great
44-
library but now it is unmaintained and has a lot of unresolved issues. Also, it weights
45-
more than 4x the size of this library with less features and less performance.
44+
library but now it is unmaintained and has a lot of unresolved issues. Also, it weighs
45+
more than 4x the size of this library with fewer features and less performance.
4646

4747
### Fetch and some state management library?
4848

4949
As this library was built to be used with axios and to handle storage itself, I can assure
50-
that it is more performant that any glued code you may find and/or write yourself. About
50+
that it is more performant than any glued code you may find and/or write yourself. About
5151
state management libraries and other similar things,
5252
[this blog post](https://arthur.place/implications-of-cache-or-state) explains why cache
53-
is more correct, architectural way, instead of state.
53+
is the more correct, architectural way, instead of state.

docs/src/guide/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ that you find will have a log to explain it.**
7575
},
7676
{
7777
"id": "-644704205",
78-
"msg": "Waiting list had an deferred for this key, waiting for it to finish"
78+
"msg": "Waiting list had a deferred for this key, waiting for it to finish"
7979
},
8080
{
8181
"id": "-644704205",

docs/src/guide/request-id.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Request Id
22

3-
We can distinguish requests from each other by assigning an **non unique** `id` to each
3+
We can distinguish requests from each other by assigning a **non-unique** `id` to each
44
request. These IDs are the same provided to the storage as keys.
55

66
Each ID is responsible for binding a cache to its request, for referencing or invalidating

docs/src/guide/storages.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Storages are responsible for saving, retrieving and serializing (if needed) cache data.
44
They are completely customizable and you can code your own, or use one published on NPM.
55

6-
They are meant to be the middleware between the cache interceptor and some sort of
6+
They are meant to act as middleware between the cache interceptor and some sort of
77
database (persistent or not) you may have. Our interceptors will call its methods
88
internally to save and retrieve data, but you can do it manually to work programmatically
99
your own way.
@@ -45,7 +45,7 @@ import Axios from 'axios';
4545
import { setupCache, buildMemoryStorage } from 'axios-cache-interceptor';
4646

4747
setupCache(axios, {
48-
// You don't need to to that, as it is the default option.
48+
// You don't need to do that, as it is the default option.
4949
storage: buildMemoryStorage(
5050
/* cloneData default=*/ false,
5151
/* cleanupInterval default=*/ 5 * 60 * 1000,
@@ -64,9 +64,9 @@ Options:
6464
- **cleanupInterval**: The interval in milliseconds to run a setInterval job of cleaning
6565
old entries. If false, the job will not be created. 5 minutes (300_000) is default
6666

67-
- **maxEntries**: The maximum number of entries to keep in the storage. Its hard to
67+
- **maxEntries**: The maximum number of entries to keep in the storage. It's hard to
6868
determine the size of the entries, so a smart FIFO order is used to determine eviction.
69-
If false, no check will be done and you may grow up memory usage. 1024 is default
69+
If false, no check will be done and you may grow memory usage. 1024 is default
7070

7171
- **maxStaleAge**: The maximum age in milliseconds a stale entry can stay in the storage
7272
before being removed. This prevents stale-able entries (those with ETag or Last-Modified

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ features:
3131
- icon: 📦
3232
title: Handy builds
3333
details:
34-
No matter what's you JS setup, we got you covered! CDN, EcmaScript, UMD, CommonJS
34+
No matter what your JS setup is, we got you covered! CDN, EcmaScript, UMD, CommonJS
3535
and URL imports.
3636

3737
- icon: 🔩

0 commit comments

Comments
 (0)