Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParseRunResult

A run parsed by the Composite Parser. This contains the Run itself and information about which parser parsed it.

Hierarchy

Index

Constructors

constructor

Properties

ptr

ptr: number

Methods

dispose

  • dispose(): void
  • Disposes the object, allowing it to clean up all of its memory. You need to call this for every object that you don't use anymore and hasn't already been disposed.

    Returns void

isGenericTimer

  • isGenericTimer(): boolean
  • Checks whether the Parser parsed a generic timer. Since a generic timer can have any name, it may clash with the specific timer formats that livesplit-core supports. With this function you can determine if a generic timer format was parsed, instead of one of the more specific timer formats.

    Returns boolean

parsedSuccessfully

  • parsedSuccessfully(): boolean

timerKind

  • timerKind(): string
  • Accesses the name of the Parser that parsed the Run. You may not call this if the Run wasn't parsed successfully.

    Returns string

unwrap

  • Moves the actual Run object out of the Result. You may not call this if the Run wasn't parsed successfully.

    Returns Run

with

  • Allows for scoped usage of the object. The object is guaranteed to get disposed once this function returns. You are free to dispose the object early yourself anywhere within the scope. The scope's return value gets carried to the outside of this function.

    Type parameters

    • T

    Parameters

    Returns T

Generated using TypeDoc