Class ActionsSource<I, O>

The source of provided by the driver.

Type parameters

I
O

Hierarchy

ActionsSource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ActionsSource(result$: Stream<ActionResult<I, O>>, name?: string, namespace?: Array<string>): ActionsSource

- Defined in source.ts:24
Parameters
- result$: Stream<ActionResult<I, O>>
- Optional name: string
- Default value namespace: Array<string> = []
Returns ActionsSource

Properties

Optional Readonly name

name: string

Readonly namespace

namespace: Array<string>

result$

result$: Stream<ActionResult<I, O>>

Methods

filter

filter(predicate: (action: Action<I>) => boolean, scope?: string): ActionsSource<I, O>

- Defined in source.ts:81
Filter results according to a predicate on the Action.

Parameters
- predicate: (action: Action<I>) => boolean
  
  the predicate
  - - (action: Action<I>): boolean
    - Parameters
      - action: Action<I>
      Returns boolean
- Optional scope: string
  
  the scope
Returns ActionsSource<I, O>

a new ActionsSource

isolateSink

isolateSink(action$: Stream<Action<I>>, scope: string | null): Stream<Action<any>>

- Defined in source.ts:59
Used by @cycle/isolate to isolate the sink.

Parameters
- action$: Stream<Action<I>>
  
  the stream of actions
- scope: string | null
  
  the scope
Returns Stream<Action<any>>

isolateSource

isolateSource(actionSource: ActionsSource<I, O>, scope: string | null): ActionsSource<I, O>

- Defined in source.ts:38
Used by @cycle/isolate to isolate the source.

Parameters
- actionSource: ActionsSource<I, O>
  
  the source
- scope: string | null
  
  the scope
Returns ActionsSource<I, O>

select

select(category?: string): SelectedResults<I, O>

- Defined in source.ts:99
Extract from the streams of result streams flatten streams.

Parameters
- Optional category: string
  
  an optional category (Action.category)
Returns SelectedResults<I, O>

the selected results

Generated using TypeDoc