effector-storage 6.1.1 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -40
- package/async-storage/index.cjs.map +1 -1
- package/async-storage/index.d.cts +24 -0
- package/async-storage/index.d.ts +14 -18
- package/async-storage/index.js.flow +6 -5
- package/async-storage/index.js.map +1 -1
- package/async-storage/package.json +15 -2
- package/broadcast/index.cjs.map +1 -1
- package/broadcast/index.d.cts +94 -0
- package/broadcast/index.d.ts +63 -85
- package/broadcast/index.js.flow +23 -25
- package/broadcast/index.js.map +1 -1
- package/broadcast/package.json +15 -2
- package/core/index.cjs +1 -1
- package/core/index.cjs.map +1 -1
- package/core/index.d.cts +77 -0
- package/core/index.d.ts +53 -66
- package/core/index.js +1 -1
- package/core/index.js.flow +14 -14
- package/core/index.js.map +1 -1
- package/core/package.json +15 -2
- package/index.d.cts +97 -0
- package/index.d.ts +68 -99
- package/index.js.flow +27 -28
- package/local/index.d.cts +99 -0
- package/local/index.d.ts +67 -90
- package/local/index.js.flow +25 -27
- package/local/package.json +15 -2
- package/log/index.cjs.map +1 -1
- package/log/index.d.cts +19 -0
- package/log/index.d.ts +11 -11
- package/log/index.js.flow +6 -5
- package/log/index.js.map +1 -1
- package/log/package.json +15 -2
- package/memory/index.d.cts +95 -0
- package/memory/index.d.ts +63 -82
- package/memory/index.js.flow +23 -25
- package/memory/package.json +15 -2
- package/nil/index.cjs.map +1 -1
- package/nil/index.d.cts +18 -0
- package/nil/index.d.ts +10 -10
- package/nil/index.js.flow +6 -5
- package/nil/index.js.map +1 -1
- package/nil/package.json +15 -2
- package/package.json +101 -57
- package/query/index.cjs.map +1 -1
- package/query/index.d.cts +108 -0
- package/query/index.d.ts +75 -104
- package/query/index.js.flow +30 -28
- package/query/index.js.map +1 -1
- package/query/package.json +15 -2
- package/session/index.d.cts +99 -0
- package/session/index.d.ts +67 -90
- package/session/index.js.flow +25 -27
- package/session/package.json +15 -2
- package/storage/index.cjs.map +1 -1
- package/storage/index.d.cts +23 -0
- package/storage/index.d.ts +15 -22
- package/storage/index.js.flow +7 -6
- package/storage/index.js.map +1 -1
- package/storage/package.json +15 -2
- package/tools/index.cjs.map +1 -1
- package/tools/{index.cjs.d.ts → index.d.cts} +33 -58
- package/tools/index.d.ts +33 -58
- package/tools/index.js.flow +13 -10
- package/tools/index.js.map +1 -1
- package/tools/package.json +15 -2
- package/async-storage/index.cjs.d.ts +0 -28
- package/broadcast/index.cjs.d.ts +0 -116
- package/core/index.cjs.d.ts +0 -90
- package/index.cjs.d.ts +0 -128
- package/local/index.cjs.d.ts +0 -122
- package/log/index.cjs.d.ts +0 -19
- package/memory/index.cjs.d.ts +0 -114
- package/nil/index.cjs.d.ts +0 -18
- package/query/index.cjs.d.ts +0 -137
- package/rn/async/index.cjs +0 -2
- package/rn/async/index.cjs.d.ts +0 -120
- package/rn/async/index.cjs.map +0 -1
- package/rn/async/index.d.ts +0 -120
- package/rn/async/index.js +0 -2
- package/rn/async/index.js.flow +0 -135
- package/rn/async/index.js.map +0 -1
- package/rn/async/package.json +0 -8
- package/rn/encrypted/index.cjs +0 -2
- package/rn/encrypted/index.cjs.d.ts +0 -120
- package/rn/encrypted/index.cjs.map +0 -1
- package/rn/encrypted/index.d.ts +0 -120
- package/rn/encrypted/index.js +0 -2
- package/rn/encrypted/index.js.flow +0 -137
- package/rn/encrypted/index.js.map +0 -1
- package/rn/encrypted/package.json +0 -8
- package/session/index.cjs.d.ts +0 -122
- package/storage/index.cjs.d.ts +0 -30
package/index.d.ts
CHANGED
|
@@ -1,128 +1,97 @@
|
|
|
1
|
-
import { Unit, Subscription, Store, Event, Effect } from 'effector'
|
|
2
|
-
export { AsyncStorageConfig, asyncStorage } from './async-storage'
|
|
3
|
-
export { BroadcastConfig, broadcast } from './broadcast'
|
|
4
|
-
export { LocalStorageConfig, local } from './local'
|
|
5
|
-
export { LogConfig, log } from './log'
|
|
6
|
-
export { MemoryConfig, memory } from './memory'
|
|
7
|
-
export { NilConfig, nil } from './nil'
|
|
8
|
-
export { QueryConfig, query } from './query'
|
|
9
|
-
export { SessionStorageConfig, session } from './session'
|
|
10
|
-
export { StorageConfig, storage } from './storage'
|
|
11
|
-
export { async, either, farcached } from './tools'
|
|
1
|
+
import { Unit, Subscription, Store, Event, Effect } from 'effector';
|
|
2
|
+
export { AsyncStorageConfig, asyncStorage } from './async-storage';
|
|
3
|
+
export { BroadcastConfig, broadcast } from './broadcast';
|
|
4
|
+
export { LocalStorageConfig, local } from './local';
|
|
5
|
+
export { LogConfig, log } from './log';
|
|
6
|
+
export { MemoryConfig, memory } from './memory';
|
|
7
|
+
export { NilConfig, nil } from './nil';
|
|
8
|
+
export { QueryConfig, query } from './query';
|
|
9
|
+
export { SessionStorageConfig, session } from './session';
|
|
10
|
+
export { StorageConfig, storage } from './storage';
|
|
11
|
+
export { async, either, farcached } from './tools';
|
|
12
12
|
|
|
13
13
|
interface StorageAdapter {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
14
|
+
<State>(key: string, update: (raw?: any) => void): {
|
|
15
|
+
get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined;
|
|
16
|
+
set(value: State, ctx?: any): void;
|
|
17
|
+
};
|
|
18
|
+
keyArea?: any;
|
|
19
|
+
noop?: boolean;
|
|
20
20
|
}
|
|
21
21
|
interface StorageAdapterFactory<AdapterConfig> {
|
|
22
|
-
|
|
23
|
-
|
|
22
|
+
(config?: AdapterConfig): StorageAdapter;
|
|
23
|
+
factory: true;
|
|
24
24
|
}
|
|
25
|
-
type Contract<Data> =
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
getErrorMessages: (raw: unknown) => string[]
|
|
30
|
-
}
|
|
25
|
+
type Contract<Data> = ((raw: unknown) => raw is Data) | {
|
|
26
|
+
isData: (raw: unknown) => raw is Data;
|
|
27
|
+
getErrorMessages: (raw: unknown) => string[];
|
|
28
|
+
};
|
|
31
29
|
type Done<State> = {
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
}
|
|
30
|
+
key: string;
|
|
31
|
+
keyPrefix: string;
|
|
32
|
+
operation: 'set' | 'get';
|
|
33
|
+
value: State;
|
|
34
|
+
};
|
|
37
35
|
type Fail<Err> = {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
}
|
|
44
|
-
type Finally<State, Err> =
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
status: 'fail'
|
|
50
|
-
})
|
|
36
|
+
key: string;
|
|
37
|
+
keyPrefix: string;
|
|
38
|
+
operation: 'set' | 'get';
|
|
39
|
+
error: Err;
|
|
40
|
+
value?: any;
|
|
41
|
+
};
|
|
42
|
+
type Finally<State, Err> = (Done<State> & {
|
|
43
|
+
status: 'done';
|
|
44
|
+
}) | (Fail<Err> & {
|
|
45
|
+
status: 'fail';
|
|
46
|
+
});
|
|
51
47
|
interface ConfigPersist {
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
48
|
+
pickup?: Unit<any>;
|
|
49
|
+
context?: Unit<any>;
|
|
50
|
+
keyPrefix?: string;
|
|
51
|
+
contract?: Contract<any>;
|
|
56
52
|
}
|
|
57
53
|
interface ConfigAdapter {
|
|
58
|
-
|
|
54
|
+
adapter: StorageAdapter;
|
|
59
55
|
}
|
|
60
56
|
interface ConfigAdapterFactory<AdapterConfig> {
|
|
61
|
-
|
|
57
|
+
adapter: StorageAdapterFactory<AdapterConfig>;
|
|
62
58
|
}
|
|
63
59
|
interface ConfigCommon<State, Err = Error> {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
60
|
+
clock?: Unit<any>;
|
|
61
|
+
done?: Unit<Done<State>>;
|
|
62
|
+
fail?: Unit<Fail<Err>>;
|
|
63
|
+
finally?: Unit<Finally<State, Err>>;
|
|
64
|
+
pickup?: Unit<any>;
|
|
65
|
+
context?: Unit<any>;
|
|
66
|
+
key?: string;
|
|
67
|
+
keyPrefix?: string;
|
|
68
|
+
contract?: Contract<State | undefined>;
|
|
73
69
|
}
|
|
74
70
|
interface ConfigJustStore<State> {
|
|
75
|
-
|
|
71
|
+
store: Store<State>;
|
|
76
72
|
}
|
|
77
73
|
interface ConfigJustSourceTarget<State> {
|
|
78
|
-
|
|
79
|
-
|
|
74
|
+
source: Store<State> | Event<State> | Effect<State, any, any>;
|
|
75
|
+
target: Store<State> | Event<State> | Effect<State, any, any>;
|
|
76
|
+
}
|
|
77
|
+
interface ConfigStore<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustStore<State> {
|
|
78
|
+
}
|
|
79
|
+
interface ConfigSourceTarget<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustSourceTarget<State> {
|
|
80
80
|
}
|
|
81
|
-
interface ConfigStore<State, Err = Error>
|
|
82
|
-
extends ConfigCommon<State, Err>,
|
|
83
|
-
ConfigJustStore<State> {}
|
|
84
|
-
interface ConfigSourceTarget<State, Err = Error>
|
|
85
|
-
extends ConfigCommon<State, Err>,
|
|
86
|
-
ConfigJustSourceTarget<State> {}
|
|
87
81
|
interface Persist {
|
|
88
|
-
|
|
89
|
-
config: ConfigAdapter &
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
config: ConfigAdapter & ConfigStore<State, Err>
|
|
93
|
-
): Subscription
|
|
94
|
-
<AdapterConfig, State, Err = Error>(
|
|
95
|
-
config: ConfigAdapterFactory<AdapterConfig> &
|
|
96
|
-
ConfigSourceTarget<State, Err> &
|
|
97
|
-
AdapterConfig
|
|
98
|
-
): Subscription
|
|
99
|
-
<AdapterConfig, State, Err = Error>(
|
|
100
|
-
config: ConfigAdapterFactory<AdapterConfig> &
|
|
101
|
-
ConfigStore<State, Err> &
|
|
102
|
-
AdapterConfig
|
|
103
|
-
): Subscription
|
|
82
|
+
<State, Err = Error>(config: ConfigAdapter & ConfigSourceTarget<State, Err>): Subscription;
|
|
83
|
+
<State, Err = Error>(config: ConfigAdapter & ConfigStore<State, Err>): Subscription;
|
|
84
|
+
<AdapterConfig, State, Err = Error>(config: ConfigAdapterFactory<AdapterConfig> & ConfigSourceTarget<State, Err> & AdapterConfig): Subscription;
|
|
85
|
+
<AdapterConfig, State, Err = Error>(config: ConfigAdapterFactory<AdapterConfig> & ConfigStore<State, Err> & AdapterConfig): Subscription;
|
|
104
86
|
}
|
|
105
87
|
|
|
106
88
|
/**
|
|
107
89
|
* Creates custom `persist`
|
|
108
90
|
*/
|
|
109
|
-
declare function createPersist(defaults?: ConfigPersist): Persist
|
|
91
|
+
declare function createPersist(defaults?: ConfigPersist): Persist;
|
|
110
92
|
/**
|
|
111
93
|
* Default `persist`
|
|
112
94
|
*/
|
|
113
|
-
declare const persist: Persist
|
|
95
|
+
declare const persist: Persist;
|
|
114
96
|
|
|
115
|
-
export {
|
|
116
|
-
ConfigPersist,
|
|
117
|
-
ConfigSourceTarget,
|
|
118
|
-
ConfigStore,
|
|
119
|
-
Contract,
|
|
120
|
-
Done,
|
|
121
|
-
Fail,
|
|
122
|
-
Finally,
|
|
123
|
-
Persist,
|
|
124
|
-
StorageAdapter,
|
|
125
|
-
StorageAdapterFactory,
|
|
126
|
-
createPersist,
|
|
127
|
-
persist,
|
|
128
|
-
}
|
|
97
|
+
export { type ConfigPersist, type ConfigSourceTarget, type ConfigStore, type Contract, type Done, type Fail, type Finally, type Persist, type StorageAdapter, type StorageAdapterFactory, createPersist, persist };
|
package/index.js.flow
CHANGED
|
@@ -5,21 +5,21 @@
|
|
|
5
5
|
* @flow
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
-
import { Unit, Subscription, Store, Event, Effect } from
|
|
9
|
-
declare export { AsyncStorageConfig, asyncStorage } from
|
|
10
|
-
declare export { BroadcastConfig, broadcast } from
|
|
11
|
-
declare export { LocalStorageConfig, local } from
|
|
12
|
-
declare export { LogConfig, log } from
|
|
13
|
-
declare export { MemoryConfig, memory } from
|
|
14
|
-
declare export { NilConfig, nil } from
|
|
15
|
-
declare export { QueryConfig, query } from
|
|
16
|
-
declare export { SessionStorageConfig, session } from
|
|
17
|
-
declare export { StorageConfig, storage } from
|
|
18
|
-
declare export { async, either, farcached } from
|
|
8
|
+
import { Unit, Subscription, Store, Event, Effect } from "effector";
|
|
9
|
+
declare export { AsyncStorageConfig, asyncStorage } from "./async-storage";
|
|
10
|
+
declare export { BroadcastConfig, broadcast } from "./broadcast";
|
|
11
|
+
declare export { LocalStorageConfig, local } from "./local";
|
|
12
|
+
declare export { LogConfig, log } from "./log";
|
|
13
|
+
declare export { MemoryConfig, memory } from "./memory";
|
|
14
|
+
declare export { NilConfig, nil } from "./nil";
|
|
15
|
+
declare export { QueryConfig, query } from "./query";
|
|
16
|
+
declare export { SessionStorageConfig, session } from "./session";
|
|
17
|
+
declare export { StorageConfig, storage } from "./storage";
|
|
18
|
+
declare export { async, either, farcached } from "./tools";
|
|
19
19
|
declare interface StorageAdapter {
|
|
20
20
|
<State>(
|
|
21
21
|
key: string,
|
|
22
|
-
update: (raw?: any) =>
|
|
22
|
+
update: (raw?: any) => void
|
|
23
23
|
): {
|
|
24
24
|
get(raw?: any, ctx?: any): State | Promise<State | void> | void,
|
|
25
25
|
set(value: State, ctx?: any): void,
|
|
@@ -38,37 +38,37 @@ declare type Contract<Data> =
|
|
|
38
38
|
isData: (raw: mixed) => boolean,
|
|
39
39
|
getErrorMessages: (raw: mixed) => string[],
|
|
40
40
|
...
|
|
41
|
-
}
|
|
41
|
+
};
|
|
42
42
|
declare type Done<State> = {
|
|
43
43
|
key: string,
|
|
44
44
|
keyPrefix: string,
|
|
45
|
-
operation:
|
|
45
|
+
operation: "set" | "get",
|
|
46
46
|
value: State,
|
|
47
47
|
...
|
|
48
|
-
}
|
|
48
|
+
};
|
|
49
49
|
declare type Fail<Err> = {
|
|
50
50
|
key: string,
|
|
51
51
|
keyPrefix: string,
|
|
52
|
-
operation:
|
|
52
|
+
operation: "set" | "get",
|
|
53
53
|
error: Err,
|
|
54
54
|
value?: any,
|
|
55
55
|
...
|
|
56
|
-
}
|
|
56
|
+
};
|
|
57
57
|
declare type Finally<State, Err> =
|
|
58
58
|
| {
|
|
59
59
|
...Done<State>,
|
|
60
60
|
...{
|
|
61
|
-
status:
|
|
61
|
+
status: "done",
|
|
62
62
|
...
|
|
63
63
|
},
|
|
64
64
|
}
|
|
65
65
|
| {
|
|
66
66
|
...Fail<Err>,
|
|
67
67
|
...{
|
|
68
|
-
status:
|
|
68
|
+
status: "fail",
|
|
69
69
|
...
|
|
70
70
|
},
|
|
71
|
-
}
|
|
71
|
+
};
|
|
72
72
|
declare interface ConfigPersist {
|
|
73
73
|
pickup?: Unit<any>;
|
|
74
74
|
context?: Unit<any>;
|
|
@@ -103,12 +103,12 @@ declare type ConfigStore<State, Err = Error> = { ... } & ConfigCommon<
|
|
|
103
103
|
State,
|
|
104
104
|
Err
|
|
105
105
|
> &
|
|
106
|
-
ConfigJustStore<State
|
|
106
|
+
ConfigJustStore<State>;
|
|
107
107
|
declare type ConfigSourceTarget<State, Err = Error> = { ... } & ConfigCommon<
|
|
108
108
|
State,
|
|
109
109
|
Err
|
|
110
110
|
> &
|
|
111
|
-
ConfigJustSourceTarget<State
|
|
111
|
+
ConfigJustSourceTarget<State>;
|
|
112
112
|
declare interface Persist {
|
|
113
113
|
<State, Err>(config: {
|
|
114
114
|
...ConfigAdapter,
|
|
@@ -129,9 +129,9 @@ declare interface Persist {
|
|
|
129
129
|
...AdapterConfig,
|
|
130
130
|
}): Subscription;
|
|
131
131
|
}
|
|
132
|
-
declare function createPersist(defaults?: ConfigPersist): Persist
|
|
133
|
-
declare var persist: Persist
|
|
134
|
-
|
|
132
|
+
declare function createPersist(defaults?: ConfigPersist): Persist;
|
|
133
|
+
declare var persist: Persist;
|
|
134
|
+
export type {
|
|
135
135
|
ConfigPersist,
|
|
136
136
|
ConfigSourceTarget,
|
|
137
137
|
ConfigStore,
|
|
@@ -142,6 +142,5 @@ declare export {
|
|
|
142
142
|
Persist,
|
|
143
143
|
StorageAdapter,
|
|
144
144
|
StorageAdapterFactory,
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
}
|
|
145
|
+
};
|
|
146
|
+
declare export { createPersist, persist };
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { Unit, Store, Event, Effect, Subscription } from 'effector';
|
|
2
|
+
|
|
3
|
+
interface StorageAdapter {
|
|
4
|
+
<State>(key: string, update: (raw?: any) => void): {
|
|
5
|
+
get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined;
|
|
6
|
+
set(value: State, ctx?: any): void;
|
|
7
|
+
};
|
|
8
|
+
keyArea?: any;
|
|
9
|
+
noop?: boolean;
|
|
10
|
+
}
|
|
11
|
+
interface StorageAdapterFactory<AdapterConfig> {
|
|
12
|
+
(config?: AdapterConfig): StorageAdapter;
|
|
13
|
+
factory: true;
|
|
14
|
+
}
|
|
15
|
+
type Contract<Data> = ((raw: unknown) => raw is Data) | {
|
|
16
|
+
isData: (raw: unknown) => raw is Data;
|
|
17
|
+
getErrorMessages: (raw: unknown) => string[];
|
|
18
|
+
};
|
|
19
|
+
type Done<State> = {
|
|
20
|
+
key: string;
|
|
21
|
+
keyPrefix: string;
|
|
22
|
+
operation: 'set' | 'get';
|
|
23
|
+
value: State;
|
|
24
|
+
};
|
|
25
|
+
type Fail<Err> = {
|
|
26
|
+
key: string;
|
|
27
|
+
keyPrefix: string;
|
|
28
|
+
operation: 'set' | 'get';
|
|
29
|
+
error: Err;
|
|
30
|
+
value?: any;
|
|
31
|
+
};
|
|
32
|
+
type Finally<State, Err> = (Done<State> & {
|
|
33
|
+
status: 'done';
|
|
34
|
+
}) | (Fail<Err> & {
|
|
35
|
+
status: 'fail';
|
|
36
|
+
});
|
|
37
|
+
interface ConfigPersist$1 {
|
|
38
|
+
pickup?: Unit<any>;
|
|
39
|
+
context?: Unit<any>;
|
|
40
|
+
keyPrefix?: string;
|
|
41
|
+
contract?: Contract<any>;
|
|
42
|
+
}
|
|
43
|
+
interface ConfigCommon<State, Err = Error> {
|
|
44
|
+
clock?: Unit<any>;
|
|
45
|
+
done?: Unit<Done<State>>;
|
|
46
|
+
fail?: Unit<Fail<Err>>;
|
|
47
|
+
finally?: Unit<Finally<State, Err>>;
|
|
48
|
+
pickup?: Unit<any>;
|
|
49
|
+
context?: Unit<any>;
|
|
50
|
+
key?: string;
|
|
51
|
+
keyPrefix?: string;
|
|
52
|
+
contract?: Contract<State | undefined>;
|
|
53
|
+
}
|
|
54
|
+
interface ConfigJustStore<State> {
|
|
55
|
+
store: Store<State>;
|
|
56
|
+
}
|
|
57
|
+
interface ConfigJustSourceTarget<State> {
|
|
58
|
+
source: Store<State> | Event<State> | Effect<State, any, any>;
|
|
59
|
+
target: Store<State> | Event<State> | Effect<State, any, any>;
|
|
60
|
+
}
|
|
61
|
+
interface ConfigStore$1<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustStore<State> {
|
|
62
|
+
}
|
|
63
|
+
interface ConfigSourceTarget$1<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustSourceTarget<State> {
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
interface ConfigPersist extends ConfigPersist$1 {
|
|
67
|
+
sync?: boolean | 'force';
|
|
68
|
+
timeout?: number;
|
|
69
|
+
}
|
|
70
|
+
interface LocalStorageConfig {
|
|
71
|
+
sync?: boolean | 'force';
|
|
72
|
+
serialize?: (value: any) => string;
|
|
73
|
+
deserialize?: (value: string) => any;
|
|
74
|
+
timeout?: number;
|
|
75
|
+
def?: any;
|
|
76
|
+
}
|
|
77
|
+
interface ConfigStore<State, Err = Error> extends LocalStorageConfig, ConfigStore$1<State, Err> {
|
|
78
|
+
}
|
|
79
|
+
interface ConfigSourceTarget<State, Err = Error> extends LocalStorageConfig, ConfigSourceTarget$1<State, Err> {
|
|
80
|
+
}
|
|
81
|
+
interface Persist {
|
|
82
|
+
<State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription;
|
|
83
|
+
<State, Err = Error>(config: ConfigStore<State, Err>): Subscription;
|
|
84
|
+
}
|
|
85
|
+
declare function local(config?: LocalStorageConfig): StorageAdapter;
|
|
86
|
+
declare namespace local {
|
|
87
|
+
var factory: true;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Creates custom partially applied `persist`
|
|
91
|
+
* with predefined `localStorage` adapter
|
|
92
|
+
*/
|
|
93
|
+
declare function createPersist(defaults?: ConfigPersist): Persist;
|
|
94
|
+
/**
|
|
95
|
+
* Default partially applied `persist`
|
|
96
|
+
*/
|
|
97
|
+
declare const persist: Persist;
|
|
98
|
+
|
|
99
|
+
export { type ConfigPersist, type ConfigSourceTarget, type ConfigStore, type Contract, type Done, type Fail, type Finally, type LocalStorageConfig, type Persist, type StorageAdapter, type StorageAdapterFactory, createPersist, local, persist };
|
package/local/index.d.ts
CHANGED
|
@@ -1,122 +1,99 @@
|
|
|
1
|
-
import { Unit, Store, Event, Effect, Subscription } from 'effector'
|
|
1
|
+
import { Unit, Store, Event, Effect, Subscription } from 'effector';
|
|
2
2
|
|
|
3
3
|
interface StorageAdapter {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
<State>(key: string, update: (raw?: any) => void): {
|
|
5
|
+
get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined;
|
|
6
|
+
set(value: State, ctx?: any): void;
|
|
7
|
+
};
|
|
8
|
+
keyArea?: any;
|
|
9
|
+
noop?: boolean;
|
|
10
10
|
}
|
|
11
11
|
interface StorageAdapterFactory<AdapterConfig> {
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
(config?: AdapterConfig): StorageAdapter;
|
|
13
|
+
factory: true;
|
|
14
14
|
}
|
|
15
|
-
type Contract<Data> =
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
getErrorMessages: (raw: unknown) => string[]
|
|
20
|
-
}
|
|
15
|
+
type Contract<Data> = ((raw: unknown) => raw is Data) | {
|
|
16
|
+
isData: (raw: unknown) => raw is Data;
|
|
17
|
+
getErrorMessages: (raw: unknown) => string[];
|
|
18
|
+
};
|
|
21
19
|
type Done<State> = {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
}
|
|
20
|
+
key: string;
|
|
21
|
+
keyPrefix: string;
|
|
22
|
+
operation: 'set' | 'get';
|
|
23
|
+
value: State;
|
|
24
|
+
};
|
|
27
25
|
type Fail<Err> = {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
}
|
|
34
|
-
type Finally<State, Err> =
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
status: 'fail'
|
|
40
|
-
})
|
|
26
|
+
key: string;
|
|
27
|
+
keyPrefix: string;
|
|
28
|
+
operation: 'set' | 'get';
|
|
29
|
+
error: Err;
|
|
30
|
+
value?: any;
|
|
31
|
+
};
|
|
32
|
+
type Finally<State, Err> = (Done<State> & {
|
|
33
|
+
status: 'done';
|
|
34
|
+
}) | (Fail<Err> & {
|
|
35
|
+
status: 'fail';
|
|
36
|
+
});
|
|
41
37
|
interface ConfigPersist$1 {
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
38
|
+
pickup?: Unit<any>;
|
|
39
|
+
context?: Unit<any>;
|
|
40
|
+
keyPrefix?: string;
|
|
41
|
+
contract?: Contract<any>;
|
|
46
42
|
}
|
|
47
43
|
interface ConfigCommon<State, Err = Error> {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
44
|
+
clock?: Unit<any>;
|
|
45
|
+
done?: Unit<Done<State>>;
|
|
46
|
+
fail?: Unit<Fail<Err>>;
|
|
47
|
+
finally?: Unit<Finally<State, Err>>;
|
|
48
|
+
pickup?: Unit<any>;
|
|
49
|
+
context?: Unit<any>;
|
|
50
|
+
key?: string;
|
|
51
|
+
keyPrefix?: string;
|
|
52
|
+
contract?: Contract<State | undefined>;
|
|
57
53
|
}
|
|
58
54
|
interface ConfigJustStore<State> {
|
|
59
|
-
|
|
55
|
+
store: Store<State>;
|
|
60
56
|
}
|
|
61
57
|
interface ConfigJustSourceTarget<State> {
|
|
62
|
-
|
|
63
|
-
|
|
58
|
+
source: Store<State> | Event<State> | Effect<State, any, any>;
|
|
59
|
+
target: Store<State> | Event<State> | Effect<State, any, any>;
|
|
60
|
+
}
|
|
61
|
+
interface ConfigStore$1<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustStore<State> {
|
|
62
|
+
}
|
|
63
|
+
interface ConfigSourceTarget$1<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustSourceTarget<State> {
|
|
64
64
|
}
|
|
65
|
-
interface ConfigStore$1<State, Err = Error>
|
|
66
|
-
extends ConfigCommon<State, Err>,
|
|
67
|
-
ConfigJustStore<State> {}
|
|
68
|
-
interface ConfigSourceTarget$1<State, Err = Error>
|
|
69
|
-
extends ConfigCommon<State, Err>,
|
|
70
|
-
ConfigJustSourceTarget<State> {}
|
|
71
65
|
|
|
72
66
|
interface ConfigPersist extends ConfigPersist$1 {
|
|
73
|
-
|
|
74
|
-
|
|
67
|
+
sync?: boolean | 'force';
|
|
68
|
+
timeout?: number;
|
|
75
69
|
}
|
|
76
70
|
interface LocalStorageConfig {
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
71
|
+
sync?: boolean | 'force';
|
|
72
|
+
serialize?: (value: any) => string;
|
|
73
|
+
deserialize?: (value: string) => any;
|
|
74
|
+
timeout?: number;
|
|
75
|
+
def?: any;
|
|
76
|
+
}
|
|
77
|
+
interface ConfigStore<State, Err = Error> extends LocalStorageConfig, ConfigStore$1<State, Err> {
|
|
78
|
+
}
|
|
79
|
+
interface ConfigSourceTarget<State, Err = Error> extends LocalStorageConfig, ConfigSourceTarget$1<State, Err> {
|
|
82
80
|
}
|
|
83
|
-
interface ConfigStore<State, Err = Error>
|
|
84
|
-
extends LocalStorageConfig,
|
|
85
|
-
ConfigStore$1<State, Err> {}
|
|
86
|
-
interface ConfigSourceTarget<State, Err = Error>
|
|
87
|
-
extends LocalStorageConfig,
|
|
88
|
-
ConfigSourceTarget$1<State, Err> {}
|
|
89
81
|
interface Persist {
|
|
90
|
-
|
|
91
|
-
|
|
82
|
+
<State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription;
|
|
83
|
+
<State, Err = Error>(config: ConfigStore<State, Err>): Subscription;
|
|
92
84
|
}
|
|
93
|
-
declare function local(config?: LocalStorageConfig): StorageAdapter
|
|
85
|
+
declare function local(config?: LocalStorageConfig): StorageAdapter;
|
|
94
86
|
declare namespace local {
|
|
95
|
-
|
|
87
|
+
var factory: true;
|
|
96
88
|
}
|
|
97
89
|
/**
|
|
98
90
|
* Creates custom partially applied `persist`
|
|
99
91
|
* with predefined `localStorage` adapter
|
|
100
92
|
*/
|
|
101
|
-
declare function createPersist(defaults?: ConfigPersist): Persist
|
|
93
|
+
declare function createPersist(defaults?: ConfigPersist): Persist;
|
|
102
94
|
/**
|
|
103
95
|
* Default partially applied `persist`
|
|
104
96
|
*/
|
|
105
|
-
declare const persist: Persist
|
|
97
|
+
declare const persist: Persist;
|
|
106
98
|
|
|
107
|
-
export {
|
|
108
|
-
ConfigPersist,
|
|
109
|
-
ConfigSourceTarget,
|
|
110
|
-
ConfigStore,
|
|
111
|
-
Contract,
|
|
112
|
-
Done,
|
|
113
|
-
Fail,
|
|
114
|
-
Finally,
|
|
115
|
-
LocalStorageConfig,
|
|
116
|
-
Persist,
|
|
117
|
-
StorageAdapter,
|
|
118
|
-
StorageAdapterFactory,
|
|
119
|
-
createPersist,
|
|
120
|
-
local,
|
|
121
|
-
persist,
|
|
122
|
-
}
|
|
99
|
+
export { type ConfigPersist, type ConfigSourceTarget, type ConfigStore, type Contract, type Done, type Fail, type Finally, type LocalStorageConfig, type Persist, type StorageAdapter, type StorageAdapterFactory, createPersist, local, persist };
|