Namespace Flow

Control execution

Logic-oriented

• StateMachine: Manage state transitions
• everyNth: Returns true for every nth call

Rate-oriented

• debounce: Only handle invocation after a minimum time has elapsed
• throttle: Only handle invocations at a maximum rate

Time-oriented

• timeout: Run code after a specified time delay
• sleep: Using async await, delay execution for a period
• sleepWhile: Keep sleeping until a predicate returns true
• delay: Using async await, run a given callback after a period
• waitFor: Calls a function and have the possibility to cancel if it takes too long
• rateMinimum: Ensures that a function is called at a set rate

Iteration over values

• repeat / @{link repeatAwait}: Runs a function a given number of times, yielding results as they come in

Monitoring

• hasElapsed: Returns true when certain time has passed
• retryFunction: Keep calling a function until it returns a value
• retryTask: Keep trying a task until it succeeds
• waitFor: Try to run something but take action if it fails or doesn't return
• singleItem: Wait for a single value to be produced
• SyncWait: Simple synchronisation
• RequestResponseMatch: Housekeeping of matching requests from A with responses from B and handling failures

Executing

• run: Run a series of async expressions, returning result / runSingle
• runOnce: Wrap a function so it only gets called once
• DispatchList: Simple foundation for publish/subscribe events
• TaskQueueMutable: Task queue

Loops

• continuously: Run code in a loop, as fast as possible or with a delay between each execution
• delayLoop: A generator that yields at a given rate

Timers

• elapsedMillisecondsAbsolute: Timer that returns elapsed time since initial invocation
• elapsedTicksAbsolute: Timer based on manual 'ticks'
• backoffGenerator: Compute increasingly-larger timeout values

Etc

• promiseFromEvent: Create a promise from an event
• promiseWithResolvers

Example: Importing

// If library is stored two directories up under `ixfx/`
import {continuously, stateMachine} from '../../ixfx/dist/flow.js';
// Import from web
import {continuosly, stateMachine} from 'https://unpkg.com/ixfx/dist/flow.js'
Copy