mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
131 lines
3.6 KiB
TypeScript
131 lines
3.6 KiB
TypeScript
// Type definitions for htmlparser2 v3.10.x
|
|
// Project: https://github.com/fb55/htmlparser2/
|
|
// Definitions by: James Roland Cabresos <https://github.com/staticfunction>
|
|
// Linus Unnebäck <https://github.com/LinusU>
|
|
// Johan Davidsson <https://github.com/johandavidson>
|
|
// GP <https://github.com/paambaati>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.2
|
|
|
|
///<reference types="node"/>
|
|
///<reference types="domhandler"/>
|
|
///<reference types="domutils"/>
|
|
|
|
import { Writable } from 'stream'
|
|
import { DomHandler } from 'domhandler';
|
|
import * as DomUtils from 'domutils';
|
|
export { DomElement, DomHandlerOptions, DomHandler, Element, Node } from 'domhandler';
|
|
|
|
export interface ParserOptions {
|
|
|
|
/***
|
|
* Indicates whether special tags (<script> and <style>) should get special treatment
|
|
* and if "empty" tags (eg. <br>) can have children. If false, the content of special tags
|
|
* will be text only. For feeds and other XML content (documents that don't consist of HTML),
|
|
* set this to true. Default: false.
|
|
*/
|
|
xmlMode?: boolean;
|
|
|
|
/***
|
|
* If set to true, entities within the document will be decoded. Defaults to false.
|
|
*/
|
|
decodeEntities?: boolean;
|
|
|
|
/***
|
|
* If set to true, all tags will be lowercased. If xmlMode is disabled, this defaults to true.
|
|
*/
|
|
lowerCaseTags?: boolean;
|
|
|
|
/***
|
|
* If set to true, all attribute names will be lowercased. This has noticeable impact on speed, so it defaults to false.
|
|
*/
|
|
lowerCaseAttributeNames?: boolean;
|
|
|
|
/***
|
|
* If set to true, CDATA sections will be recognized as text even if the xmlMode option is not enabled.
|
|
* NOTE: If xmlMode is set to true then CDATA sections will always be recognized as text.
|
|
*/
|
|
recognizeCDATA?: boolean;
|
|
|
|
/***
|
|
* If set to true, self-closing tags will trigger the onclosetag event even if xmlMode is not set to true.
|
|
* NOTE: If xmlMode is set to true then self-closing tags will always be recognized.
|
|
*/
|
|
recognizeSelfClosing?: boolean;
|
|
}
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
export type Options = ParserOptions
|
|
|
|
export declare class WritableStream extends Writable {
|
|
constructor(handler: DomHandler, options?: ParserOptions);
|
|
}
|
|
|
|
export declare class Parser {
|
|
constructor(handler: Partial<DomHandler>, options?: ParserOptions);
|
|
|
|
/***
|
|
* Parses a chunk of data and calls the corresponding callbacks.
|
|
* @param input
|
|
*/
|
|
write(input: string): void;
|
|
|
|
/***
|
|
* alias for backwards compat
|
|
*/
|
|
parseChunk(chunk: string): void;
|
|
|
|
/***
|
|
* Parses the end of the buffer and clears the stack, calls onend.
|
|
*/
|
|
end(): void;
|
|
|
|
/***
|
|
* Parses the end of the buffer and clears the stack, calls onend.
|
|
*/
|
|
end(chunk: string): void;
|
|
|
|
/***
|
|
* alias for backwards compat
|
|
*/
|
|
done(): void;
|
|
|
|
/***
|
|
* Pauses the parser
|
|
*/
|
|
pause(): void;
|
|
|
|
/***
|
|
* Resumes the parser
|
|
*/
|
|
resume(): void;
|
|
|
|
/***
|
|
* Resets the parser, parses the data & calls end.
|
|
* @param input
|
|
*/
|
|
parseComplete(input: string): void;
|
|
|
|
/***
|
|
* Resets buffer & stack, calls onreset.
|
|
*/
|
|
reset(): void;
|
|
|
|
ontext(data: any): void;
|
|
onopentagname(name: string): void;
|
|
onopentagend(): void;
|
|
onclosetag(name: string): void;
|
|
onselfclosingtag(): void;
|
|
onattribname(name: string): void;
|
|
onattribend(): void;
|
|
ondeclaration(): void;
|
|
onprocessinginstruction(value: string): void;
|
|
oncomment(value: string): void;
|
|
oncdata(value: string): void;
|
|
onerror(err: Error): void;
|
|
onend(): void;
|
|
}
|
|
|
|
export { DomUtils }
|