Class TrioWriter

Writes a trio document.

const trio = new TrioWriter()
  .addComment('A comment')
  .addNewLine()
  .addDict(dict)
  .addDict(dict2)
  .toTrio()

Hierarchy

TrioWriter

Index

Constructors

constructor

Methods

addComment addDict addGrid addNewLine toString toTrio

Constructors

constructor

new TrioWriter(): TrioWriter
Returns TrioWriter

Methods

addComment

addComment(comment?): TrioWriter
Add a comment to be written out into the trio document.
Parameters
- Optional comment: string
  
  The comment to add.
Returns TrioWriter
The trio writer instance.
- Defined in src/core/TrioWriter.ts:77

addDict

addDict(dict): TrioWriter
Add a dict to be written out into the trio document.
Parameters
- dict: HDict
Returns TrioWriter
The trio writer instance.
- Defined in src/core/TrioWriter.ts:53

addGrid

addGrid(grid): TrioWriter
Add all of a grid's rows (dicts) to the trio document.
Parameters
- grid: HGrid<HDict>
  
  The grid to add.
Returns TrioWriter
The trio writer instance.
- Defined in src/core/TrioWriter.ts:64

addNewLine

addNewLine(): TrioWriter
Adds a new line to be written out into the trio document.

Returns TrioWriter

Retursn
The trio write instance.
- Defined in src/core/TrioWriter.ts:87

toString

toString(): string
Returns string
The trio document from the writer's items.
- Defined in src/core/TrioWriter.ts:145

toTrio

toTrio(): string
Returns string
The trio document from the writer's items.
- Defined in src/core/TrioWriter.ts:95

Class TrioWriter

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns TrioWriter

Methods

addComment

Parameters

`Optional` comment: string

Returns TrioWriter

addDict

Parameters

dict: HDict

Returns TrioWriter

addGrid

Parameters

grid: HGrid<HDict>

Returns TrioWriter

addNewLine

Returns TrioWriter

Retursn

toString

Returns string

toTrio

Returns string

Settings

Member Visibility

Theme

On This Page

Class TrioWriter

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns TrioWriter

Methods

addComment

Parameters

Optional comment: string

Returns TrioWriter

addDict

Parameters

dict: HDict

Returns TrioWriter

addGrid

Parameters

grid: HGrid<HDict>

Returns TrioWriter

addNewLine

Returns TrioWriter

Retursn

toString

Returns string

toTrio

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` comment: string