Icard/angular-clarity-master(work.../node_modules/parse5-sax-parser/dist/index.d.ts

154 lines
5.4 KiB
TypeScript
Raw Normal View History

2024-07-16 14:55:36 +00:00
/// <reference types="node" />
import { Transform } from 'node:stream';
import type { Tokenizer, TokenHandler, Token } from 'parse5';
import { ParserFeedbackSimulator } from './parser-feedback-simulator.js';
export interface SAXParserOptions {
/**
* Enables source code location information for tokens.
*
* When enabled, each token will have a `sourceCodeLocation` property.
*/
sourceCodeLocationInfo?: boolean;
}
/**
* Streaming [SAX](https://en.wikipedia.org/wiki/Simple_API_for_XML)-style HTML parser.
* A [transform stream](https://nodejs.org/api/stream.html#stream_class_stream_transform) (which means you can pipe _through_ it, see example).
*
* @example
*
* ```js
* const SAXParser = require('parse5-sax-parser');
* const http = require('http');
* const fs = require('fs');
*
* const file = fs.createWriteStream('/home/google.com.html');
* const parser = new SAXParser();
*
* parser.on('text', text => {
* // Handle page text content
* ...
* });
*
* http.get('http://google.com', res => {
* // `SAXParser` is the `Transform` stream, which means you can pipe
* // through it. So, you can analyze the page content and, e.g., save it
* // to the file at the same time:
* res.pipe(parser).pipe(file);
* });
* ```
*/
export declare class SAXParser extends Transform implements TokenHandler {
protected options: SAXParserOptions;
protected parserFeedbackSimulator: ParserFeedbackSimulator;
private pendingText;
private lastChunkWritten;
private stopped;
protected tokenizer: Tokenizer;
/**
* @param options Parsing options.
*/
constructor(options?: SAXParserOptions);
_transform(chunk: string, _encoding: string, callback: (error?: Error | null, data?: string) => void): void;
_final(callback: (error?: Error | null, data?: string) => void): void;
/**
* Stops parsing. Useful if you want the parser to stop consuming CPU time
* once you've obtained the desired info from the input stream. Doesn't
* prevent piping, so that data will flow through the parser as usual.
*
* @example
*
* ```js
* const SAXParser = require('parse5-sax-parser');
* const http = require('http');
* const fs = require('fs');
*
* const file = fs.createWriteStream('google.com.html');
* const parser = new SAXParser();
*
* parser.on('doctype', ({ name, publicId, systemId }) => {
* // Process doctype info and stop parsing
* ...
* parser.stop();
* });
*
* http.get('http://google.com', res => {
* // Despite the fact that parser.stop() was called whole
* // content of the page will be written to the file
* res.pipe(parser).pipe(file);
* });
* ```
*/
stop(): void;
protected _transformChunk(chunk: string): string;
/** @internal */
onCharacter({ chars, location }: Token.CharacterToken): void;
/** @internal */
onWhitespaceCharacter(token: Token.CharacterToken): void;
/** @internal */
onNullCharacter(token: Token.CharacterToken): void;
/** @internal */
onEof(): void;
/** @internal */
onStartTag(token: Token.TagToken): void;
/** @internal */
onEndTag(token: Token.TagToken): void;
/** @internal */
onDoctype(token: Token.DoctypeToken): void;
/** @internal */
onComment(token: Token.CommentToken): void;
protected emitIfListenerExists(eventName: string, token: SaxToken): boolean;
protected _emitToken(eventName: string, token: SaxToken): void;
private _emitPendingText;
}
export interface SaxToken {
/** Source code location info. Available if location info is enabled via {@link SAXParserOptions}. */
sourceCodeLocation?: Token.Location | null;
}
export interface StartTag extends SaxToken {
/** Tag name */
tagName: string;
/** List of attributes */
attrs: Token.Attribute[];
/** Indicates if the tag is self-closing */
selfClosing: boolean;
}
export interface EndTag extends SaxToken {
/** Tag name */
tagName: string;
}
export interface Text extends SaxToken {
/** Text content. */
text: string;
}
export interface Comment extends SaxToken {
/** Comment text. */
text: string;
}
export interface Doctype extends SaxToken {
/** Document type name. */
name: string | null;
/** Document type public identifier. */
publicId: string | null;
/** Document type system identifier. */
systemId: string | null;
}
export interface SAXParser {
/** Raised when the parser encounters a start tag. */
on(event: 'startTag', listener: (startTag: StartTag) => void): this;
/** Raised when the parser encounters an end tag. */
on(event: 'endTag', listener: (endTag: EndTag) => void): this;
/** Raised when the parser encounters a comment. */
on(event: 'comment', listener: (comment: Comment) => void): this;
/** Raised when the parser encounters text content. */
on(event: 'text', listener: (text: Text) => void): this;
/** Raised when the parser encounters a [document type declaration](https://en.wikipedia.org/wiki/Document_type_declaration) */
on(event: 'doctype', listener: (doctype: Doctype) => void): this;
/**
* Base event handler.
*
* @param event Name of the event
* @param handler Event handler
*/
on(event: string, handler: (...args: any[]) => void): this;
}
//# sourceMappingURL=index.d.ts.map