JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 28
  • Score
    100M100P100Q58801F

Rodux for Roblox TypeScript

Package Exports

  • @rbxts/rodux

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rbxts/rodux) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

The roblox-ts version of Rodux, A state management library for Roblox inspired by Redux.
 

Installation

You can install it via npm i @rbxts/rodux.

Using Thunk Middleware

if you decide to use the thunk middleware, you will have to explictly set the template argments when creating Rodux.Store, otherwise it will not type correctly.

Example:

import Rodux, { combineReducers, applyMiddleware } from "@rbxts/rodux";
import characterReducer, {
    ICharacterReducer,
    CharacterActions,
} from "./CharacterReducer";

export interface IStore {
    Character: ICharacterReducer;
}

export type StoreActions = CharacterActions;

const reducers = combineReducers<IStore, StoreActions>({
    Character: characterReducer,
});

const store = new Rodux.Store<IStore, StoreActions, Rodux.ThunkDispatch<IStore, {}, StoreActions>>(
    reducers,
    {},
    [Rodux.thunkMiddleware],
);

Explicitly defining the type for Rodux.thunkMiddleware will allow you to get the correct types for the store, otherwise it will be Rodux.Store<any>

If you also use Rodux.loggerMiddleware (or any other middleware) :

const store = new Rodux.Store<IStore, StoreActions, Rodux.ThunkDispatch<IStore, {}, StoreActions>, {}>(
    reducers,
    {},
    [Rodux.thunkMiddleware, Rodux.loggerMiddleware],
);

License

The original Rodux library's License can be found here: Rodux License