Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PotentialCleanUp

Describes a potential clean up that could be applied. You can query a message describing the details of this potential clean up. A potential clean up can then be turned into an actual clean up in order to apply it to the Run.

Hierarchy

Index

Constructors

Properties

Methods

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

message

  • message(): string
  • Accesses the message describing the potential clean up that can be applied to a Run.

    Returns string

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