1 |
|
2 | import { SAXStream } from 'sax';
|
3 | import { Readable, Transform, TransformOptions, TransformCallback } from 'stream';
|
4 | import { IndexItem, ErrorLevel } from './types';
|
5 | declare type Logger = (level: 'warn' | 'error' | 'info' | 'log', ...message: Parameters<Console['log']>[0]) => void;
|
6 | export interface XMLToSitemapIndexItemStreamOptions extends TransformOptions {
|
7 | level?: ErrorLevel;
|
8 | logger?: Logger | false;
|
9 | }
|
10 |
|
11 |
|
12 |
|
13 |
|
14 | export declare class XMLToSitemapIndexStream extends Transform {
|
15 | level: ErrorLevel;
|
16 | logger: Logger;
|
17 | saxStream: SAXStream;
|
18 | constructor(opts?: XMLToSitemapIndexItemStreamOptions);
|
19 | _transform(data: string, encoding: string, callback: TransformCallback): void;
|
20 | }
|
21 | /**
|
22 | Read xml and resolve with the configuration that would produce it or reject with
|
23 | an error
|
24 | ```
|
25 | const { createReadStream } = require('fs')
|
26 | const { parseSitemapIndex, createSitemap } = require('sitemap')
|
27 | parseSitemapIndex(createReadStream('./example-index.xml')).then(
|
28 |
|
29 |
|
30 | (xmlConfig) => console.log(createSitemap(xmlConfig).toString()),
|
31 | (err) => console.log(err)
|
32 | )
|
33 | ```
|
34 | @param {Readable} xml what to parse
|
35 | @return {Promise<IndexItem[]>} resolves with list of index items that can be fed into a SitemapIndexStream. Rejects with an Error object.
|
36 | */
|
37 | export declare function parseSitemapIndex(xml: Readable): Promise<IndexItem[]>;
|
38 | export interface IndexObjectStreamToJSONOptions extends TransformOptions {
|
39 | lineSeparated: boolean;
|
40 | }
|
41 | /**
|
42 | * A Transform that converts a stream of objects into a JSON Array or a line
|
43 | * separated stringified JSON
|
44 | * @param [lineSeparated=false] whether to separate entries by a new line or comma
|
45 | */
|
46 | export declare class IndexObjectStreamToJSON extends Transform {
|
47 | lineSeparated: boolean;
|
48 | firstWritten: boolean;
|
49 | constructor(opts?: IndexObjectStreamToJSONOptions);
|
50 | _transform(chunk: IndexItem, encoding: string, cb: TransformCallback): void;
|
51 | _flush(cb: TransformCallback): void;
|
52 | }
|
53 | export {};
|
54 |
|
\ | No newline at end of file |