@cycle/core
- Version 7.0.0
- Published
- 2 dependencies
- MIT license
Install
npm i @cycle/core
yarn add @cycle/core
pnpm add @cycle/core
Overview
The Cycle run() function meant to be used with RxJS v4
Index
Variables
variable Cycle
const Cycle: CycleSetup;
A function that prepares the Cycle application to be executed. Takes a
main
function and prepares to circularly connects it to the given collection of driver functions. As an output,Cycle()
returns an object with three properties:sources
,sinks
andrun
. Only whenrun()
is called will the application actually execute. Refer to the documentation ofrun()
for more details.**Example:**
import Cycle from '@cycle/rx-run';const {sources, sinks, run} = Cycle(main, drivers);// ...const dispose = run(); // Executes the application// ...dispose();Parameter main
a function that takes
sources
as input and outputs a collection ofsinks
Observables.Parameter drivers
an object where keys are driver names and values are driver functions. {Object} an object with three properties:
sources
,sinks
andrun
.sources
is the collection of driver sources,sinks
is the collection of driver sinks, these can be used for debugging or testing.run
is the function that once called will execute the application. Cycle
Functions
function run
run: <Sources, Sinks>( main: (sources: Sources) => Sinks, drivers: { [name: string]: Function }) => DisposeFunction;
Takes a
main
function and circularly connects it to the given collection of driver functions.**Example:**
import {run} from '@cycle/rx-run';const dispose = Cycle.run(main, drivers);// ...dispose();The
main
function expects a collection of "source" Observables (returned from drivers) as input, and should return a collection of "sink" Observables (to be given to drivers). A "collection of Observables" is a JavaScript object where keys match the driver names registered by thedrivers
object, and values are the Observables. Refer to the documentation of each driver to see more details on what types of sources it outputs and sinks it receives.Parameter main
a function that takes
sources
as input and outputs a collection ofsinks
Observables.Parameter drivers
an object where keys are driver names and values are driver functions. {Function} a dispose function, used to terminate the execution of the Cycle.js program, cleaning up resources used. run
Package Files (1)
Dependencies (2)
Dev Dependencies (14)
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@cycle/core
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@cycle/core)
- HTML<a href="https://www.jsdocs.io/package/@cycle/core"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1843 ms. - Missing or incorrect documentation? Open an issue for this package.