# @types/sitemap-generator

> TypeScript definitions for sitemap-generator

Latest version **8.5.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/sitemap-generator
pnpm add @types/sitemap-generator
yarn add @types/sitemap-generator
bun add @types/sitemap-generator
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 8.5.5 |
| Published | 2023-11-07 |
| First published | 2020-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51451 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/sitemap-generator
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sitemap-generator
- npm.io page: https://npm.io/package/@types/sitemap-generator

## Dependencies (1)

- [@types/simplecrawler](https://npm.io/package/@types/simplecrawler.md) *

## Recent versions

- 8.5.5 (latest) — 2023-11-07
- 8.5.2 (ts4.3) — 2023-08-25
- 8.5.1 (ts3.6) — 2021-07-06
- 8.5.0 (ts3.3) — 2020-12-16
- 8.5.4 — 2023-10-18
- 8.5.3 — 2023-09-25

## README

# Installation
> `npm install --save @types/sitemap-generator`

# Summary
This package contains type definitions for sitemap-generator (https://github.com/lgraubner/sitemap-generator).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sitemap-generator.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sitemap-generator/index.d.ts)
````ts
import Crawler = require("simplecrawler");

type PriorityValues = 0.0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1.0;
type FreqValues = "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
type EventTypes = "add" | "done" | "error" | "ignore";
type ExcludeFunctionProps<T> = Pick<T, { [K in keyof T]: T[K] extends (...args: any[]) => void ? never : K }[keyof T]>;

type Options = Partial<ExcludeFunctionProps<Crawler>> & {
    changeFreq?: FreqValues | undefined;
    filepath?: string | null | undefined;
    ignore?: ((url: string) => boolean) | undefined;
    ignoreAMP?: boolean | undefined;
    lastMod?: boolean | undefined;
    maxEntriesPerFile?: number | undefined;
    priorityMap?: PriorityValues[] | undefined;
};

interface ErrorMessage {
    code: string;
    message: string;
    url: string;
}

interface SiteMapRotator {
    getPaths: () => string[];
    addURL: (url: string, depth?: number, lastMod?: string) => void;
    finish: () => void;
}

type EventCallback<T extends EventTypes> = T extends "error" ? (error: ErrorMessage) => void
    : T extends "add" ? (url: string) => void
    : T extends "ignore" ? (url: string) => void
    : () => void;

interface Methods {
    start: () => void;
    stop: () => void;
    getCrawler: () => Crawler;
    getSitemap: () => SiteMapRotator;
    queueURL: (url: string) => void;
    on: <T extends EventTypes>(events: T, cb: EventCallback<T>) => void;
}

declare function SitemapGenerator(url: string, options?: Options): Methods;

export = SitemapGenerator;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/simplecrawler](https://npmjs.com/package/@types/simplecrawler)

# Credits
These definitions were written by [grgr-dkrk](https://github.com/grgr-dkrk).

---
_Source: https://npm.io/package/@types/sitemap-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._