@enonic-types/lib-grid 7.14.4-RC1 → 7.15.0-A1
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/grid.d.ts +4 -10
- package/package.json +4 -2
package/grid.d.ts
CHANGED
|
@@ -1,11 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Grid related functions.
|
|
3
|
-
*
|
|
4
|
-
* @example
|
|
5
|
-
* var gridLib = require('/lib/xp/grid');
|
|
6
|
-
*
|
|
7
|
-
* @module grid
|
|
8
|
-
*/
|
|
9
1
|
declare global {
|
|
10
2
|
interface XpLibraries {
|
|
11
3
|
'/lib/xp/grid': typeof import('./grid');
|
|
@@ -13,7 +5,8 @@ declare global {
|
|
|
13
5
|
}
|
|
14
6
|
export declare type SharedMapValueType = string | number | boolean | object | null;
|
|
15
7
|
export declare type GridMap = Record<string, SharedMapValueType>;
|
|
16
|
-
export declare type SharedMapModifierFn<Map extends GridMap, Key extends keyof Map> = (value: Map[Key] | null) =>
|
|
8
|
+
export declare type SharedMapModifierFn<Map extends GridMap, Key extends keyof Map> = (value: Map[Key] | null) => ConvertedType;
|
|
9
|
+
declare type ConvertedType = SharedMapValueType | Record<string, unknown> | object[];
|
|
17
10
|
export interface SetParams<Map extends GridMap, Key extends keyof Map> {
|
|
18
11
|
key: Key;
|
|
19
12
|
value: Map[Key] | null;
|
|
@@ -25,7 +18,7 @@ export interface ModifyParams<Map extends GridMap, Key extends keyof Map> {
|
|
|
25
18
|
ttlSeconds?: number;
|
|
26
19
|
}
|
|
27
20
|
export interface SharedMap<Map extends GridMap> {
|
|
28
|
-
get<Key extends keyof Map>(key: Key): Map[Key];
|
|
21
|
+
get<Key extends keyof Map>(key: Key): Map[Key] | null;
|
|
29
22
|
set<Key extends keyof Map>(params: SetParams<Map, Key>): void;
|
|
30
23
|
modify<Key extends keyof Map>(params: ModifyParams<Map, Key>): Map[Key];
|
|
31
24
|
delete(key: keyof Map): void;
|
|
@@ -37,3 +30,4 @@ export interface SharedMap<Map extends GridMap> {
|
|
|
37
30
|
* @returns {SharedMap} an instance of SharedMap
|
|
38
31
|
*/
|
|
39
32
|
export declare function getMap<Map extends GridMap>(mapId: string): SharedMap<Map>;
|
|
33
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@enonic-types/lib-grid",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.15.0-A1",
|
|
4
4
|
"description": "Type definitions for lib-grid.",
|
|
5
5
|
"types": "grid.d.ts",
|
|
6
6
|
"files": [
|
|
@@ -26,7 +26,9 @@
|
|
|
26
26
|
"url": "https://github.com/enonic/xp/issues"
|
|
27
27
|
},
|
|
28
28
|
"homepage": "https://github.com/enonic/xp/tree/master#readme",
|
|
29
|
-
"dependencies": {
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@enonic-types/core": "7.15.0-A1"
|
|
31
|
+
},
|
|
30
32
|
"publishConfig": {
|
|
31
33
|
"access": "public"
|
|
32
34
|
}
|