npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

with-event-handlers

v1.0.1

Published

essentially a redux core within a `component-from-stream`

Downloads

2

Readme

with-event-handlers

NPM

essentially a redux core within a component-from-stream, in less than 3k bytes, non-minified, uncompressed.

create a custom props dispatcher from a given dispatcher and action creators, that adds corresponding event handlers to the props it receives before dispatching them. the reactive operator in the component-from-stream instantiated with this custom dispatcher receives an action stream (instead of a props stream), which it reduces to a stream of view props.

for components with more involved behaviours, the reducer logic may favourably be implemented with a basic-state-machine to maintain self-documenting expressive code.

Example

see the full example in this directory. run the example in your browser locally with npm run example or online here.

this example is refactored from that of component-from-stream: it demonstrates how to implement component-from-stream Components using with-event-handlers to work with an actions stream instead of props:

copy-button/behaviour.ts

import createPropsHandler, { ActionCreatorMap } from '../..'
import { omit, shallowEqual } from '../utils'
import compose from 'basic-compose'
import { into } from 'basic-cursors'
import { distinctUntilChanged, map, scan, tap } from 'rxjs/operators'
import copyToClipboard = require('clipboard-copy')

// ...

const actions: ActionCreatorMap<Action<any>> = {
  onClick(payload: any) {
    return { type: 'CLICK', payload }
  },
  enable() {
    return { type: 'ENABLE' }
  },
  onProps(payload: CopyButtonProps) {
    return { type: 'PROPS', payload }
  }
}

const dispatcher = createPropsHandler(actions)

const operator = compose(
  tap(log('copy-button:view-props:')),
  distinctUntilChanged(shallowEqual),
  map(omit('value', 'icons', 'timeout', 'enable')), // clean-up
  map(into('icon')(iconFromDisabled)),
  scan(reduce, {})
) as RxOperator<Action<any>,ButtonViewProps>

const behaviour = {
  operator, dispatcher
} as BehaviourSpec<CopyButtonProps,Action<any>,ButtonViewProps>

export default behaviour

function reduce(props, { type, payload }) {
  switch (type) {
    case 'CLICK':
      if (!doCopyToClipboard(payload, props.value)) {
        return props
      }
      setTimeout(props.enable, props.timeout) // stateful
      return { ...props, disabled: true }
    case 'ENABLE':
      return { ...props, disabled: false }
    case 'PROPS':
      const { disabled } = props
      return { ...DEFAULT_PROPS, ...payload, disabled }
    default:
      return props
  }
}

function doCopyToClipboard(event, value) {
  event.preventDefault()
  return copyToClipboard(value) //true on success
}

function iconFromDisabled ({ disabled, icons }: any) {
  return disabled ? icons.disabled : icons.enabled
}

// ...

API

for a detailed specification of this API, run the unit tests in your browser.

export interface ActionCreatorMap<A> extends IndexedMap<ActionCreator<A>> {
  onProps: ActionCreator<A>
}

export declare type EventHandlerMap =
IndexedMap<EventHandler<any> | LinkEventHandler<any, any>>

export interface IndexedMap<V> {
  [key: string]: V
}

export default function createPropsHandler<P, A>(
  actions: ActionCreatorMap<A>
): (dispatch: (val: any) => void) => (props: P) => void

export declare type EventHandler<E> = (event: E) => void

export declare type LinkEventHandler<E, D> = (data: D, event: E) => void

export interface ActionCreator<A> {
  (...args: any[]): A
}

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.