Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IExpressionEvaluator

An interface for something that evaluates arbitrary expressions.

This is distinct from the bindings in that IExpressionEvaluators can independently evaluate an expression (such as sending it to a Jupyter kernel).

TODO: What is the long-term future of these? I feel like it'd be better to ask the framework to evaluate another expresion arbitrarily, but kernel expressions are 'special' enough to warrant design considerations.

export
interface

IExpressionEvaluator

Hierarchy

  • IDisposable
    • IExpressionEvaluator

Index

Properties

Methods

Properties

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Methods

dispose

  • dispose(): void
  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

evaluate

  • evaluate(expression: string, globals: ReadonlyArray<string>): Promise<unknown>
  • Parameters

    • expression: string
    • globals: ReadonlyArray<string>

    Returns Promise<unknown>

getMetadata

  • getMetadata(): void | object

Generated using TypeDoc