svelte-sitemap 4.0.0-next.2 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dto/global.interface.d.ts +52 -0
- package/package.js +1 -1
- package/package.json +1 -1
|
@@ -2,25 +2,77 @@ import { CHANGE_FREQ, IntegrationMethod } from "../const.js";
|
|
|
2
2
|
|
|
3
3
|
//#region src/dto/global.interface.d.ts
|
|
4
4
|
interface Arguments {
|
|
5
|
+
/**
|
|
6
|
+
* Your website domain URL (e.g., 'https://example.com').
|
|
7
|
+
*/
|
|
5
8
|
domain: string;
|
|
9
|
+
/**
|
|
10
|
+
* Additional sitemap generation options.
|
|
11
|
+
*/
|
|
6
12
|
options?: Options;
|
|
7
13
|
}
|
|
8
14
|
interface Options {
|
|
15
|
+
/**
|
|
16
|
+
* Enable debug mode to display detailed log outputs during execution.
|
|
17
|
+
* @default false
|
|
18
|
+
*/
|
|
9
19
|
debug?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* How frequently the page content is likely to change.
|
|
22
|
+
* This value provides general information to search engines and may not correlate exactly to how often they crawl the page.
|
|
23
|
+
* @see {@link ChangeFreq}
|
|
24
|
+
*/
|
|
10
25
|
changeFreq?: ChangeFreq;
|
|
26
|
+
/**
|
|
27
|
+
* If set to true, resets the last modified time (`lastmod`) of all pages to the current date/time.
|
|
28
|
+
* @default false
|
|
29
|
+
*/
|
|
11
30
|
resetTime?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Custom build/output folder containing the static HTML files.
|
|
33
|
+
* @default 'build'
|
|
34
|
+
*/
|
|
12
35
|
outDir?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Whether to include an attribution comment ("Generated by svelte-sitemap") in the output sitemap.xml.
|
|
38
|
+
* @default true
|
|
39
|
+
*/
|
|
13
40
|
attribution?: boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Glob patterns or specific file/directory paths to exclude from the sitemap.
|
|
43
|
+
* @default []
|
|
44
|
+
* @example `ignore: ['**\/admin/**', 'my-secret-page']`
|
|
45
|
+
*/
|
|
14
46
|
ignore?: string | string[];
|
|
47
|
+
/**
|
|
48
|
+
* Whether to append a trailing slash to all page URLs in the sitemap.
|
|
49
|
+
* @default false
|
|
50
|
+
*/
|
|
15
51
|
trailingSlashes?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* Array of additional page paths to manually add to the sitemap (e.g. paths external to SvelteKit or static assets).
|
|
54
|
+
* @example `additional: ['my-page', 'my-second-page']`
|
|
55
|
+
*/
|
|
16
56
|
additional?: string[];
|
|
17
57
|
}
|
|
18
58
|
interface OptionsSvelteSitemap extends Options {
|
|
59
|
+
/**
|
|
60
|
+
* Your website domain URL (e.g., 'https://example.com').
|
|
61
|
+
*/
|
|
19
62
|
domain: string;
|
|
20
63
|
}
|
|
21
64
|
interface PagesJson {
|
|
65
|
+
/**
|
|
66
|
+
* The path or URL of the page.
|
|
67
|
+
*/
|
|
22
68
|
page: string;
|
|
69
|
+
/**
|
|
70
|
+
* How frequently the page content is likely to change.
|
|
71
|
+
*/
|
|
23
72
|
changeFreq?: ChangeFreq;
|
|
73
|
+
/**
|
|
74
|
+
* The last modified timestamp of the page.
|
|
75
|
+
*/
|
|
24
76
|
lastMod?: string;
|
|
25
77
|
}
|
|
26
78
|
/**
|
package/package.js
CHANGED
package/package.json
CHANGED