website hosted

node_modules/sitemap/dist/lib/sitemap-index-stream.d.ts

@@ -0,0 +1,143 @@
+/// <reference types="node" />
+import { WriteStream } from 'fs';
+import { Transform, TransformOptions, TransformCallback } from 'stream';
+import { IndexItem, SitemapItemLoose, ErrorLevel } from './types';
+import { SitemapStream } from './sitemap-stream';
+export declare enum IndexTagNames {
+    sitemap = "sitemap",
+    loc = "loc",
+    lastmod = "lastmod"
+}
+/**
+ * Options for the SitemapIndexStream
+ */
+export interface SitemapIndexStreamOptions extends TransformOptions {
+    /**
+     * Whether to output the lastmod date only (no time)
+     *
+     * @default false
+     */
+    lastmodDateOnly?: boolean;
+    /**
+     * How to handle errors in passed in urls
+     *
+     * @default ErrorLevel.WARN
+     */
+    level?: ErrorLevel;
+    /**
+     * URL to an XSL stylesheet to include in the XML
+     */
+    xslUrl?: string;
+}
+/**
+ * `SitemapIndexStream` is a Transform stream that takes `IndexItem`s or sitemap URL strings and outputs a stream of sitemap index XML.
+ *
+ * It automatically handles the XML declaration and the opening and closing tags for the sitemap index.
+ *
+ * ⚠️ CAUTION: This object is `readable` and must be read (e.g. piped to a file or to /dev/null)
+ * before `finish` will be emitted. Failure to read the stream will result in hangs.
+ *
+ * @extends {Transform}
+ */
+export declare class SitemapIndexStream extends Transform {
+    lastmodDateOnly: boolean;
+    level: ErrorLevel;
+    xslUrl?: string;
+    private hasHeadOutput;
+    /**
+     * `SitemapIndexStream` is a Transform stream that takes `IndexItem`s or sitemap URL strings and outputs a stream of sitemap index XML.
+     *
+     * It automatically handles the XML declaration and the opening and closing tags for the sitemap index.
+     *
+     * ⚠️ CAUTION: This object is `readable` and must be read (e.g. piped to a file or to /dev/null)
+     * before `finish` will be emitted. Failure to read the stream will result in hangs.
+     *
+     * @param {SitemapIndexStreamOptions} [opts=defaultStreamOpts] - Stream options.
+     */
+    constructor(opts?: SitemapIndexStreamOptions);
+    private writeHeadOutput;
+    _transform(item: IndexItem | string, encoding: string, callback: TransformCallback): void;
+    _flush(cb: TransformCallback): void;
+}
+declare type getSitemapStreamFunc = (i: number) => [IndexItem | string, SitemapStream, WriteStream];
+/**
+ * Options for the SitemapAndIndexStream
+ *
+ * @extends {SitemapIndexStreamOptions}
+ */
+export interface SitemapAndIndexStreamOptions extends SitemapIndexStreamOptions {
+    /**
+     * Max number of items in each sitemap XML file.
+     *
+     * When the limit is reached the current sitemap file will be closed,
+     * a wait for `finish` on the target write stream will happen,
+     * and a new sitemap file will be created.
+     *
+     * Range: 1 - 50,000
+     *
+     * @default 45000
+     */
+    limit?: number;
+    /**
+     * Callback for SitemapIndexAndStream that creates a new sitemap stream for a given sitemap index.
+     *
+     * Called when a new sitemap file is needed.
+     *
+     * The write stream is the destination where the sitemap was piped.
+     * SitemapAndIndexStream will wait for the `finish` event on each sitemap's
+     * write stream before moving on to the next sitemap. This ensures that the
+     * contents of the write stream will be fully written before being used
+     * by any following operations (e.g. uploading, reading contents for unit tests).
+     *
+     * @param i - The index of the sitemap file
+     * @returns A tuple containing the index item to be written into the sitemap index, the sitemap stream, and the write stream for the sitemap pipe destination
+     */
+    getSitemapStream: getSitemapStreamFunc;
+}
+/**
+ * `SitemapAndIndexStream` is a Transform stream that takes in sitemap items,
+ * writes them to sitemap files, adds the sitemap files to a sitemap index,
+ * and creates new sitemap files when the count limit is reached.
+ *
+ * It waits for the target stream of the current sitemap file to finish before
+ * moving on to the next if the target stream is returned by the `getSitemapStream`
+ * callback in the 3rd position of the tuple.
+ *
+ * ⚠️ CAUTION: This object is `readable` and must be read (e.g. piped to a file or to /dev/null)
+ * before `finish` will be emitted. Failure to read the stream will result in hangs.
+ *
+ * @extends {SitemapIndexStream}
+ */
+export declare class SitemapAndIndexStream extends SitemapIndexStream {
+    private itemsWritten;
+    private getSitemapStream;
+    private currentSitemap?;
+    private limit;
+    private currentSitemapPipeline?;
+    /**
+     * `SitemapAndIndexStream` is a Transform stream that takes in sitemap items,
+     * writes them to sitemap files, adds the sitemap files to a sitemap index,
+     * and creates new sitemap files when the count limit is reached.
+     *
+     * It waits for the target stream of the current sitemap file to finish before
+     * moving on to the next if the target stream is returned by the `getSitemapStream`
+     * callback in the 3rd position of the tuple.
+     *
+     * ⚠️ CAUTION: This object is `readable` and must be read (e.g. piped to a file or to /dev/null)
+     * before `finish` will be emitted. Failure to read the stream will result in hangs.
+     *
+     * @param {SitemapAndIndexStreamOptions} opts - Stream options.
+     */
+    constructor(opts: SitemapAndIndexStreamOptions);
+    _transform(item: SitemapItemLoose, encoding: string, callback: TransformCallback): void;
+    private writeItem;
+    /**
+     * Called when the stream is finished.
+     * If there is a current sitemap, we wait for it to finish before calling the callback.
+     *
+     * @param cb
+     */
+    _flush(cb: TransformCallback): void;
+    private createSitemap;
+}
+export {};