Skip to content

Commit 2ee153e

Browse files
Update README.md (#153)
In the described options, the `field` value was wrong. When looked into the `sitempaper.d.ts` type decleration, you can see that key `fields` is used. Co-authored-by: Sean Thomas Burke <965298+seantomburke@users.noreply.github.com>
1 parent b034070 commit 2ee153e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ You can add options on the initial Sitemapper object when instantiating it.
8282
- `lastmod`: (Number) - Timestamp of the minimum lastmod value allowed for returned urls
8383
- `proxyAgent`: (HttpProxyAgent|HttpsProxyAgent) - instance of npm "hpagent" HttpProxyAgent or HttpsProxyAgent to be passed to npm "got"
8484
- `exclusions`: (Array<RegExp>) - Array of regex patterns to exclude URLs from being processed
85-
- `field`: (Object) - An object of fields to be returned from the sitemap. Leaving a field out has the same effect as `<field>: false`. If not specified sitemapper defaults to returning the 'classic' array of urls. Available fields:
85+
- `fields`: (Object) - An object of fields to be returned from the sitemap. Leaving a field out has the same effect as `<field>: false`. If not specified sitemapper defaults to returning the 'classic' array of urls. Available fields:
8686
- `loc`: (Boolean) - The URL location of the page
8787
- `lastmod`: (Boolean) - The date of last modification of the page
8888
- `changefreq`: (Boolean) - How frequently the page is likely to change
@@ -97,7 +97,7 @@ You can add options on the initial Sitemapper object when instantiating it.
9797
For Example:
9898

9999
```
100-
field: {
100+
fields: {
101101
loc: true,
102102
lastmod: true,
103103
changefreq: true,
@@ -121,7 +121,7 @@ const sitemapper = new Sitemapper({
121121
concurrency: 2,
122122
retries: 1,
123123
rejectUnauthorized: false,
124-
field: {
124+
fields: {
125125
loc: true,
126126
lastmod: true,
127127
changefreq: true,

0 commit comments

Comments
 (0)