Skip to content

Commit

Permalink
Update README.md (#153)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
LarsDepuydt and seantomburke authored Dec 20, 2024
1 parent b034070 commit 2ee153e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ You can add options on the initial Sitemapper object when instantiating it.
- `lastmod`: (Number) - Timestamp of the minimum lastmod value allowed for returned urls
- `proxyAgent`: (HttpProxyAgent|HttpsProxyAgent) - instance of npm "hpagent" HttpProxyAgent or HttpsProxyAgent to be passed to npm "got"
- `exclusions`: (Array<RegExp>) - Array of regex patterns to exclude URLs from being processed
- `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:
- `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:
- `loc`: (Boolean) - The URL location of the page
- `lastmod`: (Boolean) - The date of last modification of the page
- `changefreq`: (Boolean) - How frequently the page is likely to change
Expand All @@ -97,7 +97,7 @@ You can add options on the initial Sitemapper object when instantiating it.
For Example:

```
field: {
fields: {
loc: true,
lastmod: true,
changefreq: true,
Expand All @@ -121,7 +121,7 @@ const sitemapper = new Sitemapper({
concurrency: 2,
retries: 1,
rejectUnauthorized: false,
field: {
fields: {
loc: true,
lastmod: true,
changefreq: true,
Expand Down

0 comments on commit 2ee153e

Please sign in to comment.