Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Attempt

An Attempt describes information about an attempt to run a specific category by a specific runner in the past. Every time a new attempt is started and then reset, an Attempt describing general information about it is created.

Hierarchy

Index

Constructors

constructor

  • This constructor is an implementation detail. Do not use this.

    Parameters

    • ptr: number

    Returns Attempt

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

ended

  • Accesses the point in time the attempt was ended at. This returns null if this information is not known.

    Returns AtomicDateTime

index

  • index(): number
  • Accesses the unique index of the attempt. This index is unique for the Run, not for all of them.

    Returns number

pauseTime

  • Accesses the amount of time the attempt has been paused for. If it is not known, this returns null. This means that it may not necessarily be possible to differentiate whether a Run has not been paused or it simply wasn't stored.

    Returns TimeSpanRef

started

  • Accesses the point in time the attempt was started at. This returns null if this information is not known.

    Returns AtomicDateTime

time

  • Accesses the split time of the last segment. If the attempt got reset early and didn't finish, this may be empty.

    Returns TimeRef

with

  • with<T>(closure: (obj: Attempt) => T): T
  • 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