@skipruntime/api

This is the Skip Runtime public API: types and operations that can be used to write and interact with reactive computations.

Type Aliases

Type alias	Description
CollectionUpdate	Partial update to a collection
DepSafe	A DepSafe value is dependency-safe and can be used safely in reactive computations.
Entry	Association of a key to multiple values.
InitialData	Initial data for a service's input collections.
Json	JSON-serializable values.
JsonObject	Objects containing Json values.
Managed	Values that are either unmodifiable or tracked by the Skip Runtime.
NamedCollections	Association of names to collections.
Nullable	Potentially null values.
Opaque	Type that is tagged to distinguish it from the underlying untagged type.
Watermark	Opaque type used as a measure of abstract time.

Interfaces

Interface	Description
Context	Skip Runtime internal state.
EagerCollection	A reactive collection eagerly kept up-to-date.
ExternalService	Interface to an external service.
LazyCollection	A lazy reactive collection, whose values are computed only when queried.
LazyCompute	Reactive function that is computed lazily and memoized.
Mapper	Reactive function that can be mapped over a collection.
Reducer	Reactive function that can be used to accumulate each key's values.
Resource	Resource provided by a SkipService.
SkipService	A Skip reactive service encapsulating a reactive computation.
Values	An iterable collection of dependency-safe values.

Classes

Class	Description
ManyToOneMapper	Specialized Mapper which maps values many-to-one.
NonUniqueValueException	Exception indicating a key did not have a unique value.
OneToManyMapper	Specialized Mapper which maps values one-to-many.
OneToOneMapper	Specialized Mapper which maps values one-to-one.

Functions

Function	Description
deepFreeze	Deep-freeze an object, making it dependency-safe.