The streaming executor manager that can be used as a transformer for +
The streaming executor manager that can be used as a transformer for Web Streams. It enqueues executor hydration chunks into the after each chunk from the read side.
The listener to subscribe.
The callback that unsubscribes the listener.
Returns serializable executor manager state.
-The base implementation of the executor manager that supports client hydration after SSR.
+The base implementation of the executor manager that supports client hydration after SSR.
The listener to subscribe.
The callback that unsubscribes the listener.
Returns serializable executor manager state.
-Streaming executor manager for NodeJS environment.
+Streaming executor manager for NodeJS environment.
The listener to subscribe.
The callback that unsubscribes the listener.
Returns serializable executor manager state.
-Aborts the pending task after the timeout if the executor is deactivated.
+Aborts the pending task after the timeout if the executor is deactivated.
The timeout in milliseconds after which the task is aborted.
-Aborts the pending task with TimeoutError if the task execution took longer then the given +
Aborts the pending task with TimeoutError if the task execution took longer then the given timeout.
The timeout in milliseconds after which the task is aborted.
-Aborts the pending task if the observable pushes false.
Aborts the pending task if the observable pushes false.
The observable that trigger the abort of the executor.
The timeout in milliseconds after false is pushed by observer before the executor is aborted.
Binds all executor methods to the instance.
-Binds all executor methods to the instance.
+Detaches a deactivated executor after the timeout.
+Detaches a deactivated executor after the timeout.
The timeout in milliseconds after which the executor is detached.
-Invalidates the settled executor result after the timeout.
+Invalidates the settled executor result after the timeout.
The timeout in milliseconds after which the executor result is invalidated.
-Invalidates the executor result if another executor with a matching key is fulfilled or invalidated.
+Invalidates the executor result if another executor with a matching key is fulfilled or invalidated.
The callback that returns a truthy value for a matching peer executor.
-Invalidates peer executors with matching keys if the executor is fulfilled or invalidated.
+Invalidates peer executors with matching keys if the executor is fulfilled or invalidated.
The callback that returns a truthy value for a matching peer executor.
-Aborts the pending task and rejects the executor with TimeoutError if the task execution took +
Aborts the pending task and rejects the executor with TimeoutError if the task execution took longer then the given timeout.
The timeout in milliseconds after which the executor is rejected.
-Resolves the executor with values pushed by an observable.
+Resolves the executor with values pushed by an observable.
The observable that pushes values.
-Repeats the last task after the execution was fulfilled.
+Repeats the last task after the execution was fulfilled.
The number of repetitions.
The delay in milliseconds after which the repetition is scheduled.
-Retries the latest task of the active executor if it was invalidated.
-Retries the latest task of the active executor if it was invalidated.
+Retries the last task after the execution has failed.
+Retries the last task after the execution has failed.
The number of times the task must be repeated if rejected.
The delay in milliseconds after which the retry is scheduled.
-Retries the latest task if the observable pushes false and then true.
Retries the latest task if the observable pushes false and then true.
The observable that triggers the retry of the latest task.
The timeout in milliseconds that should pass after false was pushed to retry the executor when true is
pushed.
Persists the executor value in the synchronous storage.
+Persists the executor value in the synchronous storage.
Synchronization is enabled only for activated executors. If executor is detached, then the corresponding item is removed from the storage.
The storage where executor value is persisted, usually a localStorage or a sessionStorage.
Additional options.
-+ExecutorManagerProvider | React Executor - v0.0.16 \ No newline at end of file +Function ExecutorManagerProvider
- Executor
Manager Provider(props): ReactNode — Big man in a suit of armour. Take that off, what are you?
— Executor, manager, provider.
Provides the ExecutorManager to underlying components.
-Parameters
- props: ProviderProps<ExecutorManager>
Returns ReactNode
Enables the SSR hydration for the given executor.
+Enables the SSR hydration for the given executor.
Note: SSR hydration can be enabled for one executor only.
The executor manager.
The executor manager for which SSR hydration must be enabled.
Additional options.
The provided executor manager.
-Gets an existing executor or create a new executor using the ExecutorManager.
+Gets an existing executor or create a new executor using the ExecutorManager.
All hook usages with the same key, return the same Executor instance.
The component is re-rendered when an executor's state is changed. The executor is activated after mount and deactivated before unmount.
@@ -16,4 +16,4 @@Optional initialValue: Value | ExecutorTask<Value> | PromiseLike<Value>The initial executor value that is applied when executor is created by the executor manager.
Optional plugins: (undefined | null | ExecutorPlugin<NoInfer<Value>>)[]The array of plugins that are applied to the newly created executor.
The executor associated with the key.
-Returns the current executor manager.
-Returns the current executor manager.
+Re-renders the component when an executor's state is changed.
+Re-renders the component when an executor's state is changed.
The executor is activated after mount and deactivated before unmount.
The executor to subscribe to.
-Suspends rendering until all of provided executors are settled.
+The predicate which a pending executor must conform to suspend the rendering process. By default, +only non-fulfilled executors are awaited.
+Serializes and deserializes values.
+Serializes and deserializes values.
Optional serializerThe storage record serializer.
Optional storageA storage key, or a callback that returns the storage key.
-Manages the async task execution process and provides ways to access execution results, abort or replace a task +
Manages the async task execution process and provides ways to access execution results, abort or replace a task execution, and subscribe to an execution state changes.
Subscribes the listener to changes of the observed value.
The listener to subscribe.
Returns the serializable executor state.
-Annotations that allow to associate arbitrary metadata with the Executor instance.
+Annotations that allow to associate arbitrary metadata with the Executor instance.
The event published by the Executor.
+The type of the event.
See ExecutorEvent for more details.
The version of the executor for which this event was published.
-Options provided to the ExecutorManager constructor.
+Options provided to the ExecutorManager constructor.
JSON.stringify
Optional pluginsPlugins that are applied to all executors.
-The minimal serializable state that is required to hydrate the Executor instance.
+The minimal serializable state that is required to hydrate the Executor instance.
Readonly reasonThe reason of the latest failure.
Readonly settledThe timestamp when the executor was settled, or 0 if it isn't settled.
Readonly valueThe value of the latest fulfillment.
-The observable that allows to subscribe to a stream of values.
+The observable that allows to subscribe to a stream of values.
Subscribes the listener to changes of the observed value.
The listener to subscribe.
-Options provided to enableSSRHydration.
+Options provided to enableSSRHydration.
Optional stateParses the executor state that was captured during SSR.
The state to parse.
-Options provided to the SSRExecutorManager constructor.
+Options provided to the SSRExecutorManager constructor.
The executor state to stringify.
JSON.stringify
The core React Executor functionality that doesn't depend on React.
+The core React Executor functionality that doesn't depend on React.
import { ExecutorManager } from 'react-executor/core';
Observable of the +
Observable of the
document.visibilityState.
import retryWhen from 'react-executor/plugin/retryWhen';
import windowFocused from 'react-executor/observable/windowFocused';
const executor = useExecutor('test', heavyTask, [
retryWhen(windowFocused)
]);
Observable of the +
Observable of the
navigator.onLine.
import retryWhen from 'react-executor/plugin/retryWhen';
import windowOnline from 'react-executor/observable/windowOnline';
const executor = useExecutor('test', heavyTask, [
retryWhen(windowOnline)
]);
The plugin that aborts the pending task after the timeout if the executor is deactivated.
+The plugin that aborts the pending task after the timeout if the executor is deactivated.
import abortDeactivated from 'react-executor/plugin/abortDeactivated';
const executor = useExecutor('test', heavyTask, [abortDeactivated()]);
The plugin that aborts the pending task with TimeoutError if the task execution took longer +
The plugin that aborts the pending task with TimeoutError if the task execution took longer then the given timeout.
import abortPending from 'react-executor/plugin/abortPending';
const executor = useExecutor('test', heavyTask, [
abortPending(10_000)
]);
The plugin that aborts the pending task if the observable pushes false.
The plugin that aborts the pending task if the observable pushes false.
import abortWhen from 'react-executor/plugin/abortWhen';
import windowFocused from 'react-executor/observable/windowFocused';
const executor = useExecutor('test', heavyTask, [
abortWhen(windowFocused)
]);
The plugin that binds all executor methods to the instance.
+The plugin that binds all executor methods to the instance.
import bindAll from 'react-executor/plugin/bindAll';
const executor = useExecutor('test', 42, [bindAll()]);
The plugin that detaches a deactivated executor after the timeout.
+The plugin that detaches a deactivated executor after the timeout.
import detachDeactivated from 'react-executor/plugin/detachDeactivated';
const executor = useExecutor('test', 42, [detachDeactivated()]);
The plugin that invalidates the settled executor result after the timeout.
+The plugin that invalidates the settled executor result after the timeout.
import invalidateAfter from 'react-executor/plugin/invalidateAfter';
const executor = useExecutor('test', 42, [invalidateAfter(5_000)]);
The plugin that invalidates the executor result if another executor with a matching key is fulfilled or invalidated.
+The plugin that invalidates the executor result if another executor with a matching key is fulfilled or invalidated.
import invalidateByPeers from 'react-executor/plugin/invalidateByPeers';
const executor = useExecutor('test', 42, [
invalidateByPeers(executor => executor.key === 'exact_executor_key')
]);
The plugin that invalidates peer executors with matching keys if the executor is fulfilled or invalidated.
+The plugin that invalidates peer executors with matching keys if the executor is fulfilled or invalidated.
import invalidatePeers from 'react-executor/plugin/invalidatePeers';
const executor = useExecutor('test', 42, [
invalidatePeers(executor => executor.key === 'exact_executor_key')
]);
The plugin that aborts the pending task and rejects the executor with TimeoutError if the task +
The plugin that aborts the pending task and rejects the executor with TimeoutError if the task execution took longer then the given timeout.
import rejectPending from 'react-executor/plugin/rejectPending';
const executor = useExecutor('test', heavyTask, [
rejectPending(10_000)
]);
The plugin that resolves the executor with values pushed by an observable.
+The plugin that resolves the executor with values pushed by an observable.
import resolveWhen from 'react-executor/plugin/resolveWhen';
const executor = useExecutor('test', heavyTask, [
resolveWhen(observable)
]);
The plugin that repeats the last task after the execution was fulfilled.
+The plugin that repeats the last task after the execution was fulfilled.
import retryFulfilled from 'react-executor/plugin/retryFulfilled';
const executor = useExecutor('test', heavyTask, [retryFulfilled()]);
The plugin that retries the latest task of the active executor if it was invalidated.
+The plugin that retries the latest task of the active executor if it was invalidated.
import retryInvalidated from 'react-executor/plugin/retryInvalidated';
const executor = useExecutor('test', heavyTask, [retryInvalidated()]);
The plugin that retries the last task after the execution has failed.
+The plugin that retries the last task after the execution has failed.
import retryRejected from 'react-executor/plugin/retryRejected';
const executor = useExecutor('test', heavyTask, [retryRejected()]);
The plugin that retries the latest task if the observable pushes false and then true.
The plugin that retries the latest task if the observable pushes false and then true.
import retryWhen from 'react-executor/plugin/retryWhen';
import windowFocused from 'react-executor/observable/windowFocused';
const executor = useExecutor('test', heavyTask, [
retryWhen(windowFocused)
]);
The plugin that persists the executor value in the synchronous storage.
+The plugin that persists the executor value in the synchronous storage.
import synchronizeStorage from 'react-executor/plugin/synchronizeStorage';
const executor = useExecutor('test', 42, [
synchronizeStorage(localStorage)
]);
The React Executor core and React integration hooks.
+The React Executor core and React integration hooks.
import { useExecutor } from 'react-executor';
Tooling for SSR implementation that supports executor hydration on the client.
+Tooling for SSR implementation that supports executor hydration on the client.
import { SSRExecutorManager } from 'react-executor/ssr';
NodeJS-specific tooling for SSR implementation that supports executor hydration on the client.
+NodeJS-specific tooling for SSR implementation that supports executor hydration on the client.
import { PipeableSSRExecutorManager } from 'react-executor/ssr/node';
The plugin callback that is invoked when the executor is created by the ExecutorManager.
+The plugin callback that is invoked when the executor is created by the ExecutorManager.
Const Observable of the +
Const Observable of the
document.visibilityState.
Const Observable of the +
Creates executors and manages their lifecycle.
+- Preparing search index...
- The search index is not available
React Executor - v0.0.16Class ExecutorManager
Creates executors and manages their lifecycle.
Hierarchy (view full)
Implements
Index
Constructors
Properties
Parameters
The listener to subscribe.
Parameters
Returns void
Returns (() => void)
The callback that unsubscribes the listener.
Returns void
toJSON
Returns serializable executor manager state.
-Returns ExecutorState<any>[]
Settings
Member Visibility
Theme
On This Page
Returns ExecutorState<any>[]
Settings
Member Visibility
Theme
On This Page