Options
All
  • Public
  • Public/Protected
  • All
Menu

Library @swim/dataflow

Swim Dataflow Library

The Swim Dataflow library implements a compiler from dynamic structure expressions to live-updated documents driven by streamlet dataflow graphs.

Overview

A live updated data structure is represented as a RecordScope, which extends the base Swim Structure Record class. An ordinary Record can be recursively compiled into a RecordScope by invoking the RecordScope.create factory method. A compiled RecordScope has all of its nested expressions replaced by their evaluated state. Unlike evaluating a Record with an Interpreter, if a member of a RecordScope changes, all expressions that transitively depend on that member get flagged for recomputation, which occurs the next time recohereInput gets invoked on the RecordScope.

The Dataflow.compile method can also be used to compile an arbitrary Swim Structure expression into an Outlet that updates whenever the state of any of its transitively dependend expressions changes.

Index

Variables

Const Dataflow

Dataflow: { compile: any; compileAndOperator: any; compileBinaryOperator: any; compileBinaryOutlet: any; compileBitwiseAndOperator: any; compileBitwiseNotOperator: any; compileBitwiseOrOperator: any; compileBitwiseXorOperator: any; compileChildrenSelector: any; compileConditionalOperator: any; compileDescendantsSelector: any; compileDivideOperator: any; compileEqOperator: any; compileFilterSelector: any; compileGeOperator: any; compileGetAttrSelector: any; compileGetItemSelector: any; compileGetSelector: any; compileGtOperator: any; compileIdentitySelector: any; compileInvokeOperator: any; compileKeysSelector: any; compileLeOperator: any; compileLtOperator: any; compileMinusOperator: any; compileModuloOperator: any; compileNeOperator: any; compileNegativeOperator: any; compileNotOperator: any; compileOperator: any; compileOrOperator: any; compilePlusOperator: any; compilePositiveOperator: any; compileSelector: any; compileTimesOperator: any; compileUnaryOperator: any; compileUnaryOutlet: any; compileValuesSelector: any }

Type declaration

RecordOutlet

RecordOutlet: { is: any }

Type declaration

  • is: function
    • Parameters

      • object: unknown

      Returns object is RecordOutlet

Generated using TypeDoc