Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlainTextConversionStream

Converts plain text files into HTML document as required by HTML specification. A writable stream.

NOTE: This API is available only for Node.js.

example

const parse5 = require('parse5');
const fs = require('fs');

const file = fs.createReadStream('war_and_peace.txt');
const converter = new parse5.PlainTextConversionStream();

converter.once('finish', () => {
    console.log(converter.document.childNodes[1].childNodes[0].tagName); //> 'head'
});

file.pipe(converter);

Hierarchy

Implements

  • WritableStream

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

document

document: Document

The resulting document node.

writable

writable: boolean

writableHighWaterMark

writableHighWaterMark: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

  • _destroy(err: Error, callback: Function): void

  • Parameters

    • err: Error
    • callback: Function

    Returns void

_final

  • _final(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: function): void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: function
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns void

Optional _writev

  • _writev(chunks: Array<object>, callback: function): void

  • Parameters

    • chunks: Array<object>
    • callback: function
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns void

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "close", listener: function): this
  • addListener(event: "drain", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: "finish", listener: function): this
  • addListener(event: "pipe", listener: function): this
  • addListener(event: "unpipe", listener: function): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

cork

  • cork(): void

  • Returns void

destroy

  • destroy(error?: Error): void

  • Parameters

    • Optional error: Error

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close"): boolean
  • emit(event: "drain", chunk: Buffer | string): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "finish"): boolean
  • emit(event: "pipe", src: Readable): boolean
  • emit(event: "unpipe", src: Readable): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "drain"
    • chunk: Buffer | string

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • Parameters

    • event: "pipe"
    • src: Readable

    Returns boolean

  • Parameters

    • event: "unpipe"
    • src: Readable

    Returns boolean

end

  • end(cb?: Function): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void

  • Parameters

    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: "script", listener: function): this
  • on(event: string, listener: Function): this

  • Raised then parser encounters a <script> element. If this event has listeners, parsing will be suspended once it is emitted. So, if <script> has the src attribute, you can fetch it, execute and then resume parsing just like browsers do.

    example
    
const parse = require('parse5');
const http = require('http');

const parser = new parse5.ParserStream();

parser.on('script', (scriptElement, documentWrite, resume) => {
    const src = parse5.treeAdapters.default.getAttrList(scriptElement)[0].value;

    http.get(src, res => {
       // Fetch the script content, execute it with DOM built around `parser.document` and
       // `document.write` implemented using `documentWrite`.
       ...
       // Then resume parsing.
       resume();
    });
});

parser.end('<script src="example.com/script.js"></script>');

    Parameters

    • event: "script"
    • listener: function
        • (scriptElement: Element, documentWrite: function, resume: function): void

        • Parameters

          • scriptElement: Element

            The script element that caused the event.

          • documentWrite: function

            Write additional html at the current parsing position. Suitable for implementing the DOM document.write and document.writeln methods.

              • (html: string): void

              • Parameters

                • html: string

                  HTML to write.

                Returns void

          • resume: function

            Resumes parsing.

              • (): void

              • Returns void

          Returns void

    Returns this

  • WritableStream events

    Parameters

    • event: string
    • listener: Function

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "close", listener: function): this
  • once(event: "drain", listener: function): this
  • once(event: "error", listener: function): this
  • once(event: "finish", listener: function): this
  • once(event: "pipe", listener: function): this
  • once(event: "unpipe", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    • T: WritableStream

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event: string, listener: function): this
  • prependListener(event: "close", listener: function): this
  • prependListener(event: "drain", listener: function): this
  • prependListener(event: "error", listener: function): this
  • prependListener(event: "finish", listener: function): this
  • prependListener(event: "pipe", listener: function): this
  • prependListener(event: "unpipe", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "drain", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: "finish", listener: function): this
  • prependOnceListener(event: "pipe", listener: function): this
  • prependOnceListener(event: "unpipe", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string, listener: function): this
  • removeListener(event: "close", listener: function): this
  • removeListener(event: "drain", listener: function): this
  • removeListener(event: "error", listener: function): this
  • removeListener(event: "finish", listener: function): this
  • removeListener(event: "pipe", listener: function): this
  • removeListener(event: "unpipe", listener: function): this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: Readable): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

setDefaultEncoding

  • setDefaultEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

uncork

  • uncork(): void

  • Returns void

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc