@xmachines/docs 6.1.0 → 7.0.0

package/api/@xmachines/play-view/index/interfaces/FailureLatch.md

@@ -1,60 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / FailureLatch
-
-# Interface: FailureLatch
-
-Defined in: [packages/play-view/src/failure-latch.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L174)
-
-The record of what a provider reported. See [createFailureLatch](../functions/createFailureLatch.md).
-
-## Methods
-
-### clear()
-
-```ts
-clear(): void;
-```
-
-Defined in: [packages/play-view/src/failure-latch.ts:191](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L191)
-
-Forgets the record, so the next failure reports again.
-
-A caller clears it on EVERY emission of a view, the null emission included: a view,
-then null, then the same view is a real sequence of an actor, and the second failure
-of that view is a second attempt that the host must hear about. It also clears it on
-a resolution that works, and on a retry that the host starts — the host asked for
-that attempt, so it must hear the result.
-
-#### Returns
-
-`void`
-
----
-
-### shouldReport()
-
-```ts
-shouldReport(
-   actor,
-   view,
-   store
-): boolean;
-```
-
-Defined in: [packages/play-view/src/failure-latch.ts:181](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L181)
-
-Answers whether a failure of these three inputs is new, and records it.
-
-#### Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| `actor`   | `unknown` |
-| `view`    | `unknown` |
-| `store`   | `unknown` |
-
-#### Returns
-
-`boolean`
-
-`true` the first time for one set of inputs, and `false` for every repeat
-of the same set. A caller reports only when it returns `true`.

package/api/@xmachines/play-view/index/interfaces/ViewInputs.md

@@ -1,19 +0,0 @@
-[API](../../../../README.md) / [@xmachines/play-view](../../README.md) / [index](../README.md) / ViewInputs
-
-# Interface: ViewInputs
-
-Defined in: [packages/play-view/src/failure-latch.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L33)
-
-The three inputs that a provider resolves a store from.
-
-`ViewStoreLifecycle.resolve` takes exactly these, and every provider names all three in
-its reset rule. The type gives the rule one name, so the comparison below stands one
-time instead of once for each renderer that needs it.
-
-## Properties
-
-| Property                            | Type      | Defined in                                                                                                                                         |
-| ----------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor` | `unknown` | [packages/play-view/src/failure-latch.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L34) |
-| <a id="property-store"></a> `store` | `unknown` | [packages/play-view/src/failure-latch.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L36) |
-| <a id="property-view"></a> `view`   | `unknown` | [packages/play-view/src/failure-latch.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-view/src/failure-latch.ts#L35) |