UNPKG

989 BTypeScriptView Raw
1/// <reference types="node" />
2import { Transform, TransformOptions, TransformCallback } from 'stream';
3import { SitemapItem, ErrorLevel } from './types';
4export interface StringObj {
5 [index: string]: any;
6}
7export interface SitemapItemStreamOptions extends TransformOptions {
8 level?: ErrorLevel;
9}
10/**
11 * Takes a stream of SitemapItemOptions and spits out xml for each
12 * @example
13 * // writes <url><loc>https://example.com</loc><url><url><loc>https://example.com/2</loc><url>
14 * const smis = new SitemapItemStream({level: 'warn'})
15 * smis.pipe(writestream)
16 * smis.write({url: 'https://example.com', img: [], video: [], links: []})
17 * smis.write({url: 'https://example.com/2', img: [], video: [], links: []})
18 * smis.end()
19 * @param level - Error level
20 */
21export declare class SitemapItemStream extends Transform {
22 level: ErrorLevel;
23 constructor(opts?: SitemapItemStreamOptions);
24 _transform(item: SitemapItem, encoding: string, callback: TransformCallback): void;
25}