rx-with-event-handler
v1.2.2
Published
RxJS operator for lifting a component-from-stream, that wraps rx-with-event-handler-props to add an event handler
Downloads
3
Maintainers
Readme
rx-with-event-handler
RxJS
operator for lifting a component-from-stream
that wraps rx-with-event-handler-props
,
adding an onEvent
event handling operator (and an optional orElse
operator).
shorthand for:
compose(
when(hasEvent(id))(onEvent, orElse),
withEventHandlerProps(id)
)
for a usage example, see the component-from-stream
module.
for more information, see the rx-with-event-handler-props
,
rx-when
and basic-compose
modules.
API
declare function withEventHandler<E>( id: string): {
(): EventHandlerPropsOperator<E, EventProp<E>> // = withEventHandlerProps(id)
<I, O = I & EventHandlerProp<E> & Partial<EventProp<E>>>(
onEvent: RxOperator<I & EventHandlerProp<E> & Partial<EventProp<E>>, O>,
orElse?: RxOperator<I & EventHandlerProp<E>, O>
): RxOperator<I, O>
}
type RxOperator<I,O> = ($: Observable<I>) => Observable<O>
when the returned function is called without handlers (no argument),
it simply passes the given event id
string through to withEventHandlerProps
from rx-with-event-handler-props
,
i.e. the following are equivalent:
import withEventHandler from 'rx-with-event-handler'
// import withEventHandlerProps from 'rx-with-event-handler-props'
withEventHandler('click')() // = withEventHandlerProps('click')
for convenience, this module exports the hasEvent
, hasEventHandler
and
toHandlerKey
helpers from rx-with-event-handler-props
.
for a partial specification of this API, run the unit tests in your browser.
TypeScript
although this library is written in TypeScript, it may also be imported into plain JavaScript code: modern code editors will still benefit from the available type definition, e.g. for helpful code completion.
License
Copyright 2018 Stéphane M. Catala
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and Limitations under the License.