website hosted

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

@@ -0,0 +1,53 @@
+/// <reference types="node" />
+import { SAXStream } from 'sax';
+import { Readable, Transform, TransformOptions, TransformCallback } from 'stream';
+import { IndexItem, ErrorLevel } from './types';
+declare type Logger = (level: 'warn' | 'error' | 'info' | 'log', ...message: Parameters<Console['log']>[0]) => void;
+export interface XMLToSitemapIndexItemStreamOptions extends TransformOptions {
+    level?: ErrorLevel;
+    logger?: Logger | false;
+}
+/**
+ * Takes a stream of xml and transforms it into a stream of IndexItems
+ * Use this to parse existing sitemap indices into config options compatible with this library
+ */
+export declare class XMLToSitemapIndexStream extends Transform {
+    level: ErrorLevel;
+    logger: Logger;
+    saxStream: SAXStream;
+    constructor(opts?: XMLToSitemapIndexItemStreamOptions);
+    _transform(data: string, encoding: string, callback: TransformCallback): void;
+}
+/**
+  Read xml and resolve with the configuration that would produce it or reject with
+  an error
+  ```
+  const { createReadStream } = require('fs')
+  const { parseSitemapIndex, createSitemap } = require('sitemap')
+  parseSitemapIndex(createReadStream('./example-index.xml')).then(
+    // produces the same xml
+    // you can, of course, more practically modify it or store it
+    (xmlConfig) => console.log(createSitemap(xmlConfig).toString()),
+    (err) => console.log(err)
+  )
+  ```
+  @param {Readable} xml what to parse
+  @return {Promise<IndexItem[]>} resolves with list of index items that can be fed into a SitemapIndexStream. Rejects with an Error object.
+ */
+export declare function parseSitemapIndex(xml: Readable): Promise<IndexItem[]>;
+export interface IndexObjectStreamToJSONOptions extends TransformOptions {
+    lineSeparated: boolean;
+}
+/**
+ * A Transform that converts a stream of objects into a JSON Array or a line
+ * separated stringified JSON
+ * @param [lineSeparated=false] whether to separate entries by a new line or comma
+ */
+export declare class IndexObjectStreamToJSON extends Transform {
+    lineSeparated: boolean;
+    firstWritten: boolean;
+    constructor(opts?: IndexObjectStreamToJSONOptions);
+    _transform(chunk: IndexItem, encoding: string, cb: TransformCallback): void;
+    _flush(cb: TransformCallback): void;
+}
+export {};