Skip to content

Commit e693561

Browse files
committed
wip
1 parent c0cbd0e commit e693561

File tree

25 files changed

+125
-112
lines changed

25 files changed

+125
-112
lines changed

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.basestate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## BaseState type
66

7-
Base state shape valid for state container
7+
Base [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) state shape
88

99
<b>Signature:</b>
1010

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.get.md

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

55
## BaseStateContainer.get property
66

7+
Retrieves current state from the container
8+
79
<b>Signature:</b>
810

911
```typescript

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export interface BaseStateContainer<State extends BaseState>
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [get](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.get.md) | <code>() =&gt; State</code> | |
20-
| [set](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.set.md) | <code>(state: State) =&gt; void</code> | |
21-
| [state$](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.state_.md) | <code>Observable&lt;State&gt;</code> | |
19+
| [get](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.get.md) | <code>() =&gt; State</code> | Retrieves current state from the container |
20+
| [set](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.set.md) | <code>(state: State) =&gt; void</code> | Sets state into container |
21+
| [state$](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.state_.md) | <code>Observable&lt;State&gt;</code> | of state |
2222

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.set.md

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

55
## BaseStateContainer.set property
66

7+
Sets state into container
8+
79
<b>Signature:</b>
810

911
```typescript

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.state_.md

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

55
## BaseStateContainer.state$ property
66

7+
of state
8+
79
<b>Signature:</b>
810

911
```typescript

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export declare function createStateContainer<State extends BaseState, PureTransi
1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
1919
| defaultState | <code>State</code> | initial state |
20-
| pureTransitions | <code>PureTransitions</code> | state transitions configuration object |
20+
| pureTransitions | <code>PureTransitions</code> | state transitions configuration object. Map of . |
2121

2222
<b>Returns:</b>
2323

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ export declare function createStateContainer<State extends BaseState, PureTransi
1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
1919
| defaultState | <code>State</code> | initial state |
20-
| pureTransitions | <code>PureTransitions</code> | state transitions configuration object |
21-
| pureSelectors | <code>PureSelectors</code> | state selectors configuration object |
22-
| options | <code>CreateStateContainerOptions</code> | |
20+
| pureTransitions | <code>PureTransitions</code> | state transitions configuration object. Map of . |
21+
| pureSelectors | <code>PureSelectors</code> | state selectors configuration object. Map of . |
22+
| options | <code>CreateStateContainerOptions</code> | state container options [CreateStateContainerOptions](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md) |
2323

2424
<b>Returns:</b>
2525

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainerreacthelpers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## createStateContainerReactHelpers variable
66

7-
Creates helpers for using [State Containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) with react
7+
Creates helpers for using [State Containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) with react Refer to \[guide\](https://github.com/elastic/kibana/blob/master/src/plugins/kibana\_utils/docs/state\_containers/react.md) for details
88

99
<b>Signature:</b>
1010

docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.dispatch.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
## Dispatch type
66

7+
Redux like dispatch
78

89
<b>Signature:</b>
910

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) &gt; [EnsurePureTransition](./kibana-plugin-plugins-kibana_utils-common-state_containers.ensurepuretransition.md)
4+
5+
## EnsurePureTransition type
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export declare type EnsurePureTransition<T> = Ensure<T, PureTransition<any, any>>;
12+
```

0 commit comments

Comments
 (0)