Skip to content

Commit 2fb970f

Browse files
committed
Rebuilt docs for 1.0
1 parent 1d489f5 commit 2fb970f

File tree

5 files changed

+21
-7
lines changed

5 files changed

+21
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ let additions =
1717
{ react-halo =
1818
{ dependencies = [ "aff", "free", "freeap", "react-basic-hooks", "wire" ]
1919
, repo = "https://github.com/robertdp/purescript-react-halo.git"
20-
, version = "v0.2.4"
20+
, version = "v1.0.0"
2121
}
2222
, wire =
2323
{ dependencies = [ "aff", "filterable", "refs", "unsafe-reference" ]

generated-docs/md/React.Halo.Internal.Control.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ The Halo parallel evaluation applicative. It lifts `HaloM` into a free applicati
7979

8080
##### Instances
8181
``` purescript
82-
Newtype (HaloAp props state action m a) _
8382
Functor (HaloAp props state action m)
8483
Apply (HaloAp props state action m)
8584
Applicative (HaloAp props state action m)
@@ -94,6 +93,14 @@ hoist :: forall props state action m m'. Functor m => (m ~> m') -> (HaloM props
9493

9594
Hoist (transform) the base monad of a `HaloM` expression.
9695

96+
#### `hoistAp`
97+
98+
``` purescript
99+
hoistAp :: forall props state action m m'. Functor m => (m ~> m') -> (HaloAp props state action m) ~> (HaloAp props state action m')
100+
```
101+
102+
Hoist (transform) the base applicative of a `HaloAp` expression.
103+
97104
#### `props`
98105

99106
``` purescript

generated-docs/md/React.Halo.Internal.Eval.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@
66
evalHaloM :: forall props state action. HaloState props state action -> (HaloM props state action Aff) ~> Aff
77
```
88

9-
Interprets `HaloM` into the base monad `Aff`.
9+
Interprets `HaloM` into the base monad `Aff` for asynchronous effects.
10+
11+
#### `evalHaloAp`
12+
13+
``` purescript
14+
evalHaloAp :: forall props state action. HaloState props state action -> (HaloAp props state action Aff) ~> ParAff
15+
```
16+
17+
Interprets `HaloAp` into the base applicative `ParAff` for parallel effects.
1018

1119
#### `evalHaloF`
1220

@@ -52,7 +60,7 @@ Simple way to run Aff logic asynchronously, while bringing errors back into Effe
5260
#### `runInitialize`
5361

5462
``` purescript
55-
runInitialize :: forall props state action. HaloState props action state -> props -> Effect Unit
63+
runInitialize :: forall props state action. HaloState props action state -> Effect Unit
5664
```
5765

5866
#### `handleUpdate`

generated-docs/md/React.Halo.Internal.State.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
``` purescript
66
newtype HaloState props state action
7-
= HaloState { eval :: Lifecycle props action -> HaloM props state action Aff Unit, forks :: Ref (Map ForkId (Fiber Unit)), fresh :: Ref Int, props :: Ref props, render :: state -> Effect Unit, state :: Ref state, subscriptions :: Ref (Map SubscriptionId (Effect Unit)), unmounted :: Ref Boolean }
7+
= HaloState { eval :: Lifecycle props action -> HaloM props state action Aff Unit, finalized :: Ref Boolean, forks :: Ref (Map ForkId (Fiber Unit)), fresh :: Ref Int, props :: Ref props, state :: Ref state, subscriptions :: Ref (Map SubscriptionId (Effect Unit)), update :: state -> Effect Unit }
88
```
99

1010
HThe alo component state used during evaluation.
1111

1212
#### `createInitialState`
1313

1414
``` purescript
15-
createInitialState :: forall props state action. state -> (Lifecycle props action -> HaloM props state action Aff Unit) -> (state -> Effect Unit) -> props -> Effect (HaloState props state action)
15+
createInitialState :: forall props state action. { eval :: Lifecycle props action -> HaloM props state action Aff Unit, props :: props, state :: state, update :: state -> Effect Unit } -> Effect (HaloState props state action)
1616
```
1717

1818
Creates a starting `HaloState`, ready for initialization.

generated-docs/md/React.Halo.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,6 @@ The Halo parallel evaluation applicative. It lifts `HaloM` into a free applicati
268268

269269
##### Instances
270270
``` purescript
271-
Newtype (HaloAp props state action m a) _
272271
Functor (HaloAp props state action m)
273272
Apply (HaloAp props state action m)
274273
Applicative (HaloAp props state action m)

0 commit comments

Comments
 (0)