@types/html-parser

Installation

npm install --save @types/html-parser

Summary

This package contains type definitions for html-parser (https://www.npmjs.com/package/html-parser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/html-parser.

index.d.ts

export type Callback = (arg: any) => any;
export type Token = ">" | "/>" | "?>";

export interface CallbacksOption {
    attribute?(name: string, value: any): void;
    openElement?(tagName: string): void;
    closeOpenedElement?(tagName: string, token: Token, isUnary: boolean): void;
    closeElement?(name: string): void;
    comment?(content: string): void;
    docType?(content: string): void;
    cdata?(content: string): void;
    xmlProlog?(): void;
    text?(value: string): void;
}

export interface RegExpOptions {
    name?: RegExp | undefined;
    attribute?: RegExp | undefined;
}

export interface RemovalCallback {
    attributes?: Callback | string[];
    elements?: Callback | string[];
    comments?: Callback | boolean;
    docTypes?: Callback | boolean;
}

export function parse(htmlString: string, callbacks?: CallbacksOption, regex?: RegExpOptions): void;

export function parseFile(
    fileName: string,
    encoding: string | undefined,
    callbacks: CallbacksOption,
    callback: Callback,
): void;

export function sanitize(htmlString: string, removalCallbacks?: RemovalCallback): string;

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Vladimir Grenaderov https://github.com/VladimirGrenaderov, // Max Boguslavskiy.