• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Class: PlainTextConversionStream
2
3Converts plain text files into HTML document as required by [HTML specification](https://html.spec.whatwg.org/#read-text). A [writable stream](https://nodejs.org/api/stream.html#stream_class_stream_writable).
4
5*__example__*:
6
7```js
8const PlainTextConversionStream = require('parse5-plain-text-conversion-stream');
9const fs = require('fs');
10
11const file = fs.createReadStream('war_and_peace.txt');
12const converter = new PlainTextConversionStream();
13
14converter.once('finish', () => {
15    console.log(converter.document.childNodes[1].childNodes[0].tagName); //> 'head'
16});
17
18file.pipe(converter);
19```
20
21### Constructors
22
23* [constructor](#constructor)
24
25### Properties
26
27* [document](#document)
28
29### Methods and events
30
31See: [writable stream API](https://nodejs.org/api/stream.html#stream_class_stream_writable).
32
33---
34
35## Constructors
36
37<a id="constructor"></a>
38
39###  constructor
40
41⊕ **new PlainTextConversionStream**(options?: *[ParserOptions](../../parse5/parser-options.md)*): [PlainTextConversionStream]()
42
43**Parameters:**
44
45| Param | Type | Description |
46| ------ | ------ | ------ |
47| `Optional` options | [ParserOptions](../../parse5/parser-options.md) |  Parsing options. |
48
49**Returns:** [PlainTextConversionStream]()
50
51___
52
53## Properties
54
55<a id="document"></a>
56
57###  document
58
59**● document**: *Document*
60
61The resulting document node.
62
63___
64