Class: EventStream
@react-form-builder/core.EventStream
The event stream of the form viewer.
Constructors
constructor
• new EventStream(stream)
Creates the event stream of the form viewer.
Parameters
| Name | Type | Description |
|---|---|---|
stream | Observable<ActionEventArgs> | the set of observable events. |
Methods
filter
▸ filter(predicate): EventStream
Returns the event stream filtered by the specified predicate function.
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (args: ActionEventArgs) => boolean | the predicate function. |
Returns
the event stream filtered by the specified predicate function.
keys
▸ keys(...keys): EventStream
Returns the event stream filtered by the specified sender keys.
Parameters
| Name | Type | Description |
|---|---|---|
...keys | string[] | the sender key array. |
Returns
the event stream filtered by the specified sender keys.
listen
▸ listen(next): () => void
Adds the subscriber to the stream of observed events.
Parameters
| Name | Type | Description |
|---|---|---|
next | (value: ActionEventArgs) => void | the subscriber function. |
Returns
fn
▸ (): void
Adds the subscriber to the stream of observed events.
Returns
void
▸ listen(observer): () => void
Adds the specified observer to the stream of observed events.
Parameters
| Name | Type | Description |
|---|---|---|
observer | Partial<Observer<ActionEventArgs>> | the observer. |
Returns
fn
▸ (): void
Adds the specified observer to the stream of observed events.
Returns
void
types
▸ types(...types): EventStream
Returns the event stream filtered by the specified event types.
Parameters
| Name | Type | Description |
|---|---|---|
...types | string[] | the array of event types. |
Returns
the event stream filtered by the specified event types.