Module

ReduxDevTools

Package
purescript-redux-devtools
Repository
justinwoo/purescript-redux-devtools

#Extension Source

data Extension :: Type

The actual Redux DevTools Extension object, retrieved with getExtension

#Instance Source

data Instance :: Type

An instance of Redux DevTools, typically created with connect

#getExtension Source

getExtension :: Effect (Maybe Extension)

Get the Redux DevTools Extension object, Maybe for the value being missing

#connect Source

connect :: Extension -> ConnectOptions -> Effect Instance

Get an instance that attaches to Redux DevTools

#Message Source

type Message = { id :: InstanceId, payload :: Foreign, source :: String, state :: State, type :: String }

Messages from Redux DevTools on events for subscribe

#InstanceId Source

type InstanceId = String

Instance Id used by Redux DevTools

#send Source

send :: Instance -> { action :: Action, state :: State } -> Effect Unit

#ConnectOptions Source

data ConnectOptions :: Type

Redux DevTools connect options

#mkConnectOptions Source

mkConnectOptions :: forall r' r. Union r r' AllConnectOptions => Record r -> ConnectOptions

make Redux DevTools Connect Options by specifying any subset of options

#AllConnectOptions Source

type AllConnectOptions = (actionCreators :: Foreign, actionSanitizer :: Action -> Foreign, actionsBlacklist :: Array String, actionsWhitelist :: Array String, features :: FeaturesOptions, latency :: Milliseconds, maxAge :: IntGreaterThanOne, name :: String, predicate :: EffectFn2 State Action Boolean, shouldRecordChanges :: Boolean, stateSanitizer :: State -> Foreign)

Options that may be passed to Redux DevTools connect See https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md Not all options will be completely typed unless contributed. Submit an issue or PR for more.

#FeaturesOptions Source

data FeaturesOptions :: Type

A set of feature flags for Redux DevTools connect options

#mkFeaturesOptions Source

mkFeaturesOptions :: forall r' r. Union r r' AllFeaturesOptions => Record r -> FeaturesOptions

make Redux DevTools Features Options by specifying any subset of options

#AllFeaturesOptions Source

type AllFeaturesOptions = (dispatch :: Boolean, export :: Boolean, import :: String, jump :: Boolean, lock :: Boolean, pause :: Boolean, persist :: Boolean, reorder :: Boolean, skip :: Boolean, test :: Boolean)

Options that may be passed to features for Redux DevTools connect options See https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md#features Not all options will be completely typed unless contributed. Submit an issue or PR for more.

#Action Source

type Action = Foreign

Type alias for Foreign that is an Action of your application

#State Source

type State = Foreign

Type alias for Foreign that is the State of your application

#Milliseconds Source

type Milliseconds = Number

Type alias for Number that is a Millisecond quantity

#IntGreaterThanOne Source

type IntGreaterThanOne = Int

Type alias for Int that is greater than 1

Modules
ReduxDevTools