Home > @unseenco/backstage-dataverse
backstage-dataverse package
The animation-optimized FRP library powering the internals of Backstage.js.
Classes
| Class | Description |
|---|---|
| Atom | Wraps an object whose (sub)properties can be individually tracked. |
| PointerProxy | Allows creating pointer-prisms where the pointer can be switched out. |
| Ticker | The Ticker class helps schedule callbacks. Scheduled callbacks are executed per tick. Ticks can be triggered by an external scheduling strategy, e.g. a raf. |
Functions
| Function | Description |
|---|---|
| isPrism(d) | Returns whether d is a prism. |
| iterateAndCountTicks(pointerOrPrism) | |
| iterateOver(pointerOrPrism) | |
| pointer(args) | Creates a pointer to a (nested) property of an Atom. |
Interfaces
| Interface | Description |
|---|---|
| PointerToPrismProvider | Interface for objects that can provide a prism at a certain path. |
| Prism | Common interface for prisms. |
Variables
| Variable | Description |
|---|---|
| getPointerParts | Returns the root object and the path of the pointer. |
| isPointer | Returns whether p is a pointer. |
| pointerToPrism | Returns a prism of the value at the provided pointer. Prisms are cached per pointer. |
| prism | Creates a prism from the passed function that adds all prisms referenced in it as dependencies, and reruns the function when these change. |
| val | Convenience function that returns a plain value from its argument, whether it is a pointer, a prism or a plain value itself. |
Type Aliases
| Type Alias | Description |
|---|---|
| Pointer | The type of Atom pointers. See pointer() for an explanation of pointers. |
| PointerMeta | |
| PointerType | A wrapper type for the type a Pointer points to. |