diff --git a/docs/crocks/Arrow.md b/docs/crocks/Arrow.md index 1c4a451cd..01624eb9b 100644 --- a/docs/crocks/Arrow.md +++ b/docs/crocks/Arrow.md @@ -14,14 +14,10 @@ | Constructor | Instance | |:---|:---| -| [`empty`](#empty), [`type`](#type) | [`both`](#both), [`concat`](#concat), [`contramap`](#contramap), [`empty`](#empty), [`first`](#first), [`inspect`](#inspect), [`map`](#map), [`promap`](#promap), [`runWith`](#runWith), [`second`](#second), [`type`](#type), [`value`](#value) | +| [`type`](#type) | [`both`](#both), [`contramap`](#contramap), [`first`](#first), [`inspect`](#inspect), [`map`](#map), [`promap`](#promap), [`runWith`](#runWith), [`second`](#second), [`type`](#type) | ## Constructor -### empty - -`Arrow m => () -> m a a` - ### type `() -> String` @@ -32,18 +28,10 @@ `Arrow m, Pair p => m a b ~> () -> m (p a a) (p b b)` -### concat - -`Arrow m => m a b ~> m a b -> m a b` - ### contramap `Arrow m => m a b ~> (c -> a) -> m c b` -### empty - -`Arrow m => () -> m a a` - ### first `Arrow m, Pair p => m a b ~> () -> m (p a c) (p b c)` @@ -71,7 +59,3 @@ ### type `() -> String` - -### value - -`Arrow m => m a b ~> (a -> b)` diff --git a/docs/crocks/Star.md b/docs/crocks/Star.md new file mode 100644 index 000000000..37857a0fd --- /dev/null +++ b/docs/crocks/Star.md @@ -0,0 +1,61 @@ +# Star + +`Star a b` / `Monad m => Star a (m b)` + +-- + +-- + +```js +-- +``` + +`Star` exposes the following functions on the constructor and instance: + +| Constructor | Instance | +|:---|:---| +| [`type`](#type) | [`both`](#both), [`contramap`](#contramap), [`first`](#first), [`inspect`](#inspect), [`map`](#map), [`promap`](#promap), [`runWith`](#runWith), [`second`](#second), [`type`](#type) | + +## Constructor + +### type + +`() -> String` + +## Instance + +### both + +`Star m, Pair p => m a b ~> () -> m (p a a) (p b b)` + +### contramap + +`Star m => m a b ~> (c -> a) -> m c b` + +### first + +`Star m, Pair p => m a b ~> () -> m (p a c) (p b c)` + +### inspect + +`() -> String` + +### map + +`Star m => m a b ~> (b -> c) -> m a c` + +### promap + +`Star m => m a b ~> ((c -> a), (b -> d)) -> s c d` + +### runWith + +`Star s, Monad m => s a (m b) ~> a -> m b` + +### second + +`Star m, Pair p => m a b ~> () -> m (p c a) (p c b)` + +### type + +`() -> String`