lrc-ast

Index

Classes

UnexpectedTokenError

Interfaces

Type aliases

Functions

Type aliases

LyricLine

LyricLine: { text: string; time: TimeLabel }

Type declaration

text: string
time: TimeLabel

TimeLabel

TimeLabel: [number, number, number]

Functions

createLrc

createLrc(ast: FileNode | LyricObject, options?: CreateLrcOptions): string

- Defined in src/createLrc.ts:59
Create lrc file from AST or lyric object.

Parameters
- ast: FileNode | LyricObject
  
  The AST (or lyric object).
- Optional options: CreateLrcOptions
  
  The options.
Returns string

The lrc file.

createObject

createObject(ast: FileNode): LyricObject

- Defined in src/createObject.ts:9
Create a JS object of lyrics from AST.

Parameters
- ast: FileNode
  
  The AST
Returns LyricObject

JS object of lyric.

parser

parser(file: string): FileNode

- Defined in src/parser.ts:163
throws

UnexpectedTokenError

Parameters
- file: string
  
  lrc file to parse.
Returns FileNode

AST root node.

Generated using TypeDoc