version 0.5.6

gcanti · May 19, 2020 · 48d03a2 · 48d03a2
1 parent 300daaa
commit 48d03a2
Show file tree

Hide file tree

Showing 20 changed files with 281 additions and 272 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,9 +13,14 @@
 **Note**: Gaps between patch versions are faulty/broken releases. **Note**: A feature tagged as Experimental is in a
 high state of flux, you're at risk of it changing without notice.
 
+## 0.5.6
+
+- **Internal**
+  - add a namespace to `Decoder`'s `URI` in order to avoid name collision (@StefanoMagrassi)
+
 ## 0.5.5
 
-- **Bug Fix:**
+- **Bug Fix**
   - fix `response` for `BadStatus` error in order to comply with `Response` type (@StefanoMagrassi)
 
 ## 0.5.4

diff --git a/docs/modules/Cmd.ts.md b/docs/modules/Cmd.ts.md
@@ -17,10 +17,10 @@ Added in v0.5.0
 <h2 class="text-delta">Table of contents</h2>
 
 - [Cmd (interface)](#cmd-interface)
-- [none (constant)](#none-constant)
-- [batch (function)](#batch-function)
-- [map (function)](#map-function)
-- [of (function)](#of-function)
+- [batch](#batch)
+- [map](#map)
+- [none](#none)
+- [of](#of)
 
 ---
 
@@ -34,50 +34,50 @@ export interface Cmd<Msg> extends Observable<Task<Option<Msg>>> {}
 
 Added in v0.5.0
 
-# none (constant)
+# batch
 
-A `none` command is an empty stream.
+Batches the execution of a list of commands.
 
 **Signature**
 
 ```ts
-export const none: Cmd<never> = ...
+export declare function batch<Msg>(arr: Array<Cmd<Msg>>): Cmd<Msg>
 ```
 
 Added in v0.5.0
 
-# batch (function)
+# map
 
-Batches the execution of a list of commands.
+Maps the carried `Msg` of a `Cmd` into another `Msg`.
 
 **Signature**
 
 ```ts
-export function batch<Msg>(arr: Array<Cmd<Msg>>): Cmd<Msg> { ... }
+export declare function map<A, Msg>(f: (a: A) => Msg): (cmd: Cmd<A>) => Cmd<Msg>
 ```
 
 Added in v0.5.0
 
-# map (function)
+# none
 
-Maps the carried `Msg` of a `Cmd` into another `Msg`.
+A `none` command is an empty stream.
 
 **Signature**
 
 ```ts
-export function map<A, Msg>(f: (a: A) => Msg): (cmd: Cmd<A>) => Cmd<Msg> { ... }
+export declare const none: Cmd<never>
 ```
 
 Added in v0.5.0
 
-# of (function)
+# of
 
 Creates a new `Cmd` that carries the provided `Msg`.
 
 **Signature**
 
 ```ts
-export function of<Msg>(m: Msg): Cmd<Msg> { ... }
+export declare function of<Msg>(m: Msg): Cmd<Msg>
 ```
 
 Added in v0.5.0
diff --git a/docs/modules/Debug/Html.ts.md b/docs/modules/Debug/Html.ts.md
@@ -39,14 +39,14 @@ Added in v0.5.3
 
 <h2 class="text-delta">Table of contents</h2>
 
-- [programWithDebugger (function)](#programwithdebugger-function)
-- [programWithDebuggerWithFlags (function)](#programwithdebuggerwithflags-function)
-- [programWithDebuggerWithFlagsWithStop (function)](#programwithdebuggerwithflagswithstop-function)
-- [programWithDebuggerWithStop (function)](#programwithdebuggerwithstop-function)
+- [programWithDebugger](#programwithdebugger)
+- [programWithDebuggerWithFlags](#programwithdebuggerwithflags)
+- [programWithDebuggerWithFlagsWithStop](#programwithdebuggerwithflagswithstop)
+- [programWithDebuggerWithStop](#programwithdebuggerwithstop)
 
 ---
 
-# programWithDebugger (function)
+# programWithDebugger
 
 Adds a debugging capability to a generic `Html` `Program`.
 
@@ -73,67 +73,67 @@ or applying a message with:
 **Signature**
 
 ```ts
-export function programWithDebugger<Model, Msg, Dom>(
+export declare function programWithDebugger<Model, Msg, Dom>(
   init: [Model, Cmd<Msg>],
   update: (msg: Msg, model: Model) => [Model, Cmd<Msg>],
   view: (model: Model) => Html<Dom, Msg>,
   subscriptions?: (model: Model) => Sub<Msg>
-): Program<Model, Msg, Dom> { ... }
+): Program<Model, Msg, Dom>
 ```
 
 Added in v0.5.3
 
-# programWithDebuggerWithFlags (function)
+# programWithDebuggerWithFlags
 
 Same as `programWithDebugger()` but with `Flags` that can be passed when the `Program` is created in order to manage initial values.
 
 **Signature**
 
 ```ts
-export function programWithDebuggerWithFlags<Flags, Model, Msg, Dom>(
+export declare function programWithDebuggerWithFlags<Flags, Model, Msg, Dom>(
   init: (flags: Flags) => [Model, Cmd<Msg>],
   update: (msg: Msg, model: Model) => [Model, Cmd<Msg>],
   view: (model: Model) => Html<Dom, Msg>,
   subscriptions?: (model: Model) => Sub<Msg>
-): (flags: Flags) => Program<Model, Msg, Dom> { ... }
+): (flags: Flags) => Program<Model, Msg, Dom>
 ```
 
 Added in v0.5.3
 
-# programWithDebuggerWithFlagsWithStop (function)
+# programWithDebuggerWithFlagsWithStop
 
 Same as `programWithDebuggerWithStop()` but with `Flags` that can be passed when the `Program` is created in order to manage initial values.
 
 **Signature**
 
 ```ts
-export function programWithDebuggerWithFlagsWithStop<Model, Msg, Dom>(
+export declare function programWithDebuggerWithFlagsWithStop<Model, Msg, Dom>(
   stopDebuggerOn: Observable<unknown>
 ): <Flags, S extends Model, M extends Msg, D extends Dom>(
   init: (flags: Flags) => [S, Cmd<M>],
   update: (msg: M, model: S) => [S, Cmd<M>],
   view: (model: S) => Html<D, M>,
   subscriptions?: (model: S) => Sub<M>
-) => (flags: Flags) => Program<S, M, D> { ... }
+) => (flags: Flags) => Program<S, M, D>
 ```
 
 Added in v0.5.4
 
-# programWithDebuggerWithStop (function)
+# programWithDebuggerWithStop
 
 A function that requires an `Observable` and returns a `programWithDebugger()` function: the underlying debugger will stop when the `Observable` emits a value.
 
 **Signature**
 
 ```ts
-export function programWithDebuggerWithStop<Model, Msg, Dom>(
+export declare function programWithDebuggerWithStop<Model, Msg, Dom>(
   stopDebuggerOn: Observable<unknown>
 ): <S extends Model, M extends Msg, D extends Dom>(
   init: [S, Cmd<M>],
   update: (msg: M, model: S) => [S, Cmd<M>],
   view: (model: S) => Html<D, M>,
   subscriptions?: (model: S) => Sub<M>
-) => Program<S, M, D> { ... }
+) => Program<S, M, D>
 ```
 
 Added in v0.5.4
diff --git a/docs/modules/Debug/Navigation.ts.md b/docs/modules/Debug/Navigation.ts.md
@@ -41,14 +41,14 @@ Added in v0.5.3
 
 <h2 class="text-delta">Table of contents</h2>
 
-- [programWithDebugger (function)](#programwithdebugger-function)
-- [programWithDebuggerWithFlags (function)](#programwithdebuggerwithflags-function)
-- [programWithDebuggerWithFlagsWithStop (function)](#programwithdebuggerwithflagswithstop-function)
-- [programWithDebuggerWithStop (function)](#programwithdebuggerwithstop-function)
+- [programWithDebugger](#programwithdebugger)
+- [programWithDebuggerWithFlags](#programwithdebuggerwithflags)
+- [programWithDebuggerWithFlagsWithStop](#programwithdebuggerwithflagswithstop)
+- [programWithDebuggerWithStop](#programwithdebuggerwithstop)
 
 ---
 
-# programWithDebugger (function)
+# programWithDebugger
 
 Adds a debugging capability to a generic `Navigation` `Program`.
 
@@ -75,71 +75,71 @@ or applying a message with:
 **Signature**
 
 ```ts
-export function programWithDebugger<Model, Msg, Dom>(
+export declare function programWithDebugger<Model, Msg, Dom>(
   locationToMessage: (location: Location) => Msg,
   init: (location: Location) => [Model, Cmd<Msg>],
   update: (msg: Msg, model: Model) => [Model, Cmd<Msg>],
   view: (model: Model) => Html<Dom, Msg>,
   subscriptions?: (model: Model) => Sub<Msg>
-): Program<Model, Msg, Dom> { ... }
+): Program<Model, Msg, Dom>
 ```
 
 Added in v0.5.3
 
-# programWithDebuggerWithFlags (function)
+# programWithDebuggerWithFlags
 
 Same as `programWithDebugger()` but with `Flags` that can be passed when the `Program` is created in order to manage initial values.
 
 **Signature**
 
 ```ts
-export function programWithDebuggerWithFlags<Flags, Model, Msg, Dom>(
+export declare function programWithDebuggerWithFlags<Flags, Model, Msg, Dom>(
   locationToMessage: (location: Location) => Msg,
   init: (flags: Flags) => (location: Location) => [Model, Cmd<Msg>],
   update: (msg: Msg, model: Model) => [Model, Cmd<Msg>],
   view: (model: Model) => Html<Dom, Msg>,
   subscriptions?: (model: Model) => Sub<Msg>
-): (flags: Flags) => Program<Model, Msg, Dom> { ... }
+): (flags: Flags) => Program<Model, Msg, Dom>
 ```
 
 Added in v0.5.3
 
-# programWithDebuggerWithFlagsWithStop (function)
+# programWithDebuggerWithFlagsWithStop
 
 Same as `programWithDebuggerWithStop()` but with `Flags` that can be passed when the `Program` is created in order to manage initial values.
 
 **Signature**
 
 ```ts
-export function programWithDebuggerWithFlagsWithStop<Model, Msg, Dom>(
+export declare function programWithDebuggerWithFlagsWithStop<Model, Msg, Dom>(
   stopDebuggerOn: Observable<unknown>
 ): <Flags, S extends Model, M extends Msg, D extends Dom>(
   locationToMessage: (location: Location) => M,
   init: (flags: Flags) => (location: Location) => [S, Cmd<M>],
   update: (msg: M, model: S) => [S, Cmd<M>],
   view: (model: S) => Html<D, M>,
   subscriptions?: (model: S) => Sub<M>
-) => (flags: Flags) => Program<S, M, D> { ... }
+) => (flags: Flags) => Program<S, M, D>
 ```
 
 Added in v0.5.4
 
-# programWithDebuggerWithStop (function)
+# programWithDebuggerWithStop
 
 A function that requires an `Observable` and returns a `programWithDebugger()` function: the underlying debugger will stop when the `Observable` emits a value.
 
 **Signature**
 
 ```ts
-export function programWithDebuggerWithStop<Model, Msg, Dom>(
+export declare function programWithDebuggerWithStop<Model, Msg, Dom>(
   stopDebuggerOn: Observable<unknown>
 ): <S extends Model, M extends Msg, D extends Dom>(
   locationToMessage: (location: Location) => M,
   init: (location: Location) => [S, Cmd<M>],
   update: (msg: M, model: S) => [S, Cmd<M>],
   view: (model: S) => Html<D, M>,
   subscriptions?: (model: S) => Sub<M>
-) => Program<S, M, D> { ... }
+) => Program<S, M, D>
 ```
 
 Added in v0.5.4
diff --git a/docs/modules/Debug/commons.ts.md b/docs/modules/Debug/commons.ts.md
@@ -23,10 +23,10 @@ Added in v0.5.0
 - [DebugData (type alias)](#debugdata-type-alias)
 - [Global (type alias)](#global-type-alias)
 - [MsgWithDebug (type alias)](#msgwithdebug-type-alias)
-- [debugInit (function)](#debuginit-function)
-- [debugMsg (function)](#debugmsg-function)
-- [runDebugger (function)](#rundebugger-function)
-- [updateWithDebug (function)](#updatewithdebug-function)
+- [debugInit](#debuginit)
+- [debugMsg](#debugmsg)
+- [runDebugger](#rundebugger)
+- [updateWithDebug](#updatewithdebug)
 
 ---
 
@@ -147,31 +147,31 @@ export type MsgWithDebug<Model, Msg> =
 
 Added in v0.5.0
 
-# debugInit (function)
+# debugInit
 
 Creates a `DebugInit`
 
 **Signature**
 
 ```ts
-export const debugInit = (): DebugInit => ...
+export declare const debugInit: () => DebugInit
 ```
 
 Added in v0.5.0
 
-# debugMsg (function)
+# debugMsg
 
 Creates a `DebugMsg`
 
 **Signature**
 
 ```ts
-export const debugMsg = <Msg>(payload: Msg): DebugMsg<Msg> => ...
+export declare const debugMsg: <Msg>(payload: Msg) => DebugMsg<Msg>
 ```
 
 Added in v0.5.0
 
-# runDebugger (function)
+# runDebugger
 
 Checks which type of debugger can be used (standard `console` or _Redux DevTool Extension_) based on provided `window` and prepares the subscription to the "debug" stream
 
@@ -180,15 +180,15 @@ Checks which type of debugger can be used (standard `console` or _Redux DevTool
 **Signature**
 
 ```ts
-export function runDebugger<Model, Msg>(
+export declare function runDebugger<Model, Msg>(
   win: Global,
   stop$: Observable<unknown>
-): (deps: DebuggerR<Model, Msg>) => IO<void> { ... }
+): (deps: DebuggerR<Model, Msg>) => IO<void>
 ```
 
 Added in v0.5.4
 
-# updateWithDebug (function)
+# updateWithDebug
 
 Adds debugging capability to the provided `update` function.
 
@@ -215,10 +215,10 @@ or applying a message with:
 **Signature**
 
 ```ts
-export function updateWithDebug<Model, Msg>(
+export declare function updateWithDebug<Model, Msg>(
   debug$: BehaviorSubject<DebugData<Model, Msg>>,
   update: (msg: Msg, model: Model) => [Model, Cmd<Msg>]
-): (msg: MsgWithDebug<Model, Msg>, model: Model) => [Model, Cmd<Msg>] { ... }
+): (msg: MsgWithDebug<Model, Msg>, model: Model) => [Model, Cmd<Msg>]
 ```
 
 Added in v0.5.3