Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/interceptors

interceptors

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Interceptor based event bus, side effect & immutable state handling.

Event bus, interceptors, side effects

Interceptors: Event and Effect primitives

Reference

The idea of interceptors is quite similar to functional composition and AOP (aspect oriented programming). You want to reuse some functionality across components within your app. For example, if you have multiple actions which should be undoable, you can compose your main event handlers with the snapShot() interceptor, which requires a @thi.ng/atom/History-like instance and records a snapshot of the current app state, but else is completely invisible.

[UNDOABLE_EVENT]: [snapshot(), valueSetter("foo")]

Event Handlers

The idea of event handlers is being responsible to assign parameters to side effects, rather than executing effects themselves, is again mainly to do with the DRY-principle, instrumentation potential and performance. Most composed event handler chains are setup so that your "actual" main handler is last in line in the pre processing phase. If e.g. your event handlers would directly update the state atom, then any attached watches (derived views, cursors, other subscriptions) would be re-run each time. By assigning the updated state to, e.g., an FX_STATE event, we can avoid these interim updates and only apply the new state once all events in the current frame have been processed. Furthermore, a post interceptor might cancel the event due to validation errors etc.

Events vs Effects:

To briefly summarize the differences between event handlers & effects:

Event handlers are triggered by events, but each event handler is technically a chain of interceptors (even though many are just a single item). Even if you just specify a single function, it's internally translated into an array of interceptor objects like:

valueSetter("route") -> [{ pre: (...) => {[FX_STATE]: ...}, post: undefined }]

When processing an event, these interceptors are then executed first in ascending order for any pre functions and then backwards again for any post functions (only if there are any in the chain). So if you had defined an handler with this chain: [{pre: f1, post: f2}, {pre: f3}, {pre: f4, post: f5}], then the functions would be called in this order: f1, f3, f4, f5, f2. The post phase is largely intended for state/effect validation & logging post-update. I.e., interceptors commonly need pre only.

Like with trace() some interceptors DO have side effects, but they're really the exception to the rule. For example, snapshot() is idempotent since it only records a new snapshot if it's different from the last and trace(), but is typically used during development only - its side effect is outside the scope of your app (i.e. the console).

Great, but why?

In most apps there're far more event types/handlers than possible actions any component can take. So assigning them to registered side effects enables better code reuse. Another use-case is debugging. With a break point set at the beginning of processEffects() (in event-bus.ts) you can see exactly which side effects have occurred at each frame. This can be very helpful for debugging and avoid having to "keep everything in your head" or - as Rich Hickey would say - make your app "Easier to reason about".

More comprehensive description forthcoming. Please check the detailed commented source code and examples for now:

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/interceptors
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/interceptors?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/interceptors/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 2.15 KB / CJS: 2.28 KB / UMD: 2.26 KB

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

ScreenshotDescriptionLive demoSource
Minimal demo using interceptors with an async side effectDemoSource
Custom dropdown UI component w/ fuzzy searchDemoSource
Event handling w/ interceptors and side effectsDemoSource
Event handling w/ interceptors and side effectsDemoSource
Complete mini SPA app w/ router & async content loadingDemoSource
Interactive grid generator, SVG generation & export, undo/redo supportDemoSource
Additive waveform synthesis & SVG visualization with undo/redoDemoSource

API

Generated API docs

TODO

Authors

Maintainer

Contributors

License

© 2016 - 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc