Class TJAParser

TJAParser is a class that parses a TJA file into a Song object. TJA is the file format used by Taiko simulators for defining chart data.

Hierarchy

TJAParser

Index

Constructors

Methods

parse stringify

Constructors

constructor

new TJAParser(): TJAParser
Returns TJAParser

Methods

`Static` parse

parse(raw: string, strict?: boolean): Song
Takes in the contents of a TJA file, parses it line-by-line, and returns a Song object. Throws if strict is set to true.

Returns
- A Song object containing data about a chart file.
Parameters
- raw: string
  
  The contents of the TJA file.
- strict: boolean = true
  
  Whether the parser should throw errors on invalid data.
Returns Song
- Defined in src/Parser.ts:35

`Static` stringify

stringify(song: Song): string
Wrapper method for Song#toString() which can be used to stringify a Song data object (similar to JSON's stringify method).

Returns
The TJA-compatible representation of the Song object.
Parameters
- song: Song
  
  The Song object to stringify.
Returns string
- Defined in src/Parser.ts:107

Generated using TypeDoc