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

typedflux

v0.1.1

Published

Simple flux stores for typescript based frontend

Downloads

69

Readme

typedflux

Simple flux stores for typescript based frontend

Usage

fluxapp

./app/fluxapp.ts

import * as typedflux from 'typedflux';
import { Dispatcher } from 'flux';

const dispatcher = new Dispatcher()
export const FluxApp = new typedflux.FluxApp(dispatcher)

actions

import {Actions} from 'typedflux';
import {FluxApp} from './fluxapp';

interface User {
    name: string
    rating: number
}

class UserActionsCls {
     create = Actions.Make<User>  // simple action, which return dispatched data
     create2(user: User) { //same as create
        return user
     }
     
     vote(user: User, vote: 1 | -1) { // action which modifies dispatched data
          return {
              rating: user.rating + vote
          }
     }
     
     dummy = Actions.MakeEmpty() // action which do not dispatch any data
     dummy2() { //same as dummy
      
     }
     deleteSuccess = Actions.Make<string>()
     deleteFailed = Actions.Make<Error>()
}

return const UserActions = FluxApp.CreateActions(UserActionsCls)

Store

import { BaseInterface, BaseStore, Bind, Request } from 'typedflux';
import {FluxApp} from './fluxapp';
import { UserActions } from './user_actions';
import { List } from 'immutable';

class State {
    users: List<User> //you can use plain objects, not immutable
    constructor() {
      this.users = new List()
    }
}

class UserInterface extends BaseInterface<State> { 
// this is external, public store interface, which will be called from views
// it can read state but can't modify it
// interface can't access stores methods

    getUsers() { // can be called from views
        return users.sort(u => u.rating)
    }
    
    // making api requests
    @Request(UserActions.deleteSuccess, UserActions.deleteFailed) // typechecked here
    async DeleteUser(id: number) {
        await makeApiRequest(id) // if throws error - sends error to deleteFailed action
         
        return 'ok' //sends result to deleteSuccess action
    }
    
}

class UserStoreCls extends BaseStore<State, UserInterface> {
   state = new State()
   
   @Bind(UserActions.create) // type checked here action type and callback type
   onCreate(user: User) {
      const newState = this.state.updateIn(['users'], users => users.push(user))
      this.setState(newState)
   }
   
   @Bind(UsersActions.vote)
   onVote(user: User) { // get's return type of action, not [user: User, vote: 1 | -1]
       ...
   }
   
   someFunction() {
       const users = this.interface.getUsers() //can access interface actions
       ...
   }
   
   @Bind(UsersActions.deleteSuccess)
   onDeleteSuccess(res: string) {
       ...
   }
      
   @Bind(UsersActions.deleteFailed)
   onDeleteFailed(err: Error) {
       ...
   }
}

export const UserStore = FluxApp.CreateStore(UserStoreCls, UserInterface)

Views

import {Connect} from 'typedflux';
import {UserActions} from './actions';
import {UserStore} fomr './store';

interface Props {
}

interface State {
   users: List<User>
}

@Connect<Props, State>([UserStore, {
  'users': UserStore.getUsers, //type checked. `'users'` is key in State. `UserStore.getUsers` is function which returns value for that key
  // otherkey: otherval
}],
// [SomeOtherStore, SomeOtherMapping]
)
class MyView extends React.Component<Props, State> {
   someMethod() {
       UserStore.deleteUser(id)
   }
   otherMethod() {
       UserActions.create(user)
   }
   render() {
       return this.state.users.map ....
   }
}