@types/office-runtime 1.0.22 → 1.0.23
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.
- office-runtime/README.md +1 -1
- office-runtime/index.d.ts +40 -10
- office-runtime/package.json +2 -2
office-runtime/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-runtime (https://github.com/Of
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 05 Nov 2021 22:31:34 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `OfficeRuntime`
|
|
14
14
|
|
office-runtime/index.d.ts
CHANGED
|
@@ -33,9 +33,12 @@ declare namespace OfficeRuntime {
|
|
|
33
33
|
/**
|
|
34
34
|
* Asynchronous, global, and persistent key-value storage.
|
|
35
35
|
*
|
|
36
|
-
* [Api set: SharedRuntime 1.1]
|
|
37
|
-
*
|
|
38
36
|
* @remarks
|
|
37
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
38
|
+
*
|
|
39
|
+
* **Important**: In Outlook, support is only available with
|
|
40
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
41
|
+
*
|
|
39
42
|
* Storage limit is 10 MB per domain, which may be shared by multiple add-ins.
|
|
40
43
|
*/
|
|
41
44
|
interface Storage {
|
|
@@ -43,7 +46,11 @@ declare namespace OfficeRuntime {
|
|
|
43
46
|
* Retrieves an item from storage based on its key.
|
|
44
47
|
* Returns a Promise. In the event the Promise does not resolve, returns null.
|
|
45
48
|
*
|
|
46
|
-
*
|
|
49
|
+
* @remarks
|
|
50
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
51
|
+
*
|
|
52
|
+
* **Important**: In Outlook, support is only available with
|
|
53
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
47
54
|
*
|
|
48
55
|
* @param key Key of item to be retrieved. Must be a string.
|
|
49
56
|
*/
|
|
@@ -52,7 +59,11 @@ declare namespace OfficeRuntime {
|
|
|
52
59
|
* Sets a key-value pair into storage or updates an existing key-value pair.
|
|
53
60
|
* Returns a Promise.
|
|
54
61
|
*
|
|
55
|
-
*
|
|
62
|
+
* @remarks
|
|
63
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
64
|
+
*
|
|
65
|
+
* **Important**: In Outlook, support is only available with
|
|
66
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
56
67
|
*
|
|
57
68
|
* @param key Key of item to be set. Must be a string.
|
|
58
69
|
* @param value Must be a string.
|
|
@@ -62,7 +73,11 @@ declare namespace OfficeRuntime {
|
|
|
62
73
|
* Removes an item from storage based on its key.
|
|
63
74
|
* Returns a Promise.
|
|
64
75
|
*
|
|
65
|
-
*
|
|
76
|
+
* @remarks
|
|
77
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
78
|
+
*
|
|
79
|
+
* **Important**: In Outlook, support is only available with
|
|
80
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
66
81
|
*
|
|
67
82
|
* @param key Key of item to be removed. Must be a string.
|
|
68
83
|
*/
|
|
@@ -71,7 +86,11 @@ declare namespace OfficeRuntime {
|
|
|
71
86
|
* Retrieves multiple items from storage based on their key.
|
|
72
87
|
* Returns a Promise. In the event the Promise does not resolve, returns null.
|
|
73
88
|
*
|
|
74
|
-
*
|
|
89
|
+
* @remarks
|
|
90
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
91
|
+
*
|
|
92
|
+
* **Important**: In Outlook, support is only available with
|
|
93
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
75
94
|
*
|
|
76
95
|
* @param keys Keys of items to be removed. Must be an array of strings.
|
|
77
96
|
*/
|
|
@@ -80,7 +99,11 @@ declare namespace OfficeRuntime {
|
|
|
80
99
|
* Sets multiple items into storage or updates multiple items within storage.
|
|
81
100
|
* Returns a Promise.
|
|
82
101
|
*
|
|
83
|
-
*
|
|
102
|
+
* @remarks
|
|
103
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
104
|
+
*
|
|
105
|
+
* **Important**: In Outlook, support is only available with
|
|
106
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
84
107
|
*
|
|
85
108
|
* @param keyValues Key-value pairs to be set. Must be strings.
|
|
86
109
|
*/
|
|
@@ -89,17 +112,24 @@ declare namespace OfficeRuntime {
|
|
|
89
112
|
* Removes multiple items from storage.
|
|
90
113
|
* Returns a Promise.
|
|
91
114
|
*
|
|
92
|
-
*
|
|
115
|
+
* @remarks
|
|
116
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
117
|
+
*
|
|
118
|
+
* **Important**: In Outlook, support is only available with
|
|
119
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
93
120
|
*
|
|
94
121
|
* @param keys Keys of items to be removed. Must be an array of strings.
|
|
95
122
|
*/
|
|
96
123
|
removeItems(keys: string[]): Promise<void>;
|
|
97
124
|
/**
|
|
98
125
|
* Retrieves an array of all keys from storage.
|
|
99
|
-
*
|
|
126
|
+
* Returns a Promise.
|
|
100
127
|
*
|
|
101
|
-
*
|
|
128
|
+
* @remarks
|
|
129
|
+
* [Api set: SharedRuntime 1.1, Mailbox 1.10]
|
|
102
130
|
*
|
|
131
|
+
* **Important**: In Outlook, support is only available with
|
|
132
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
103
133
|
*/
|
|
104
134
|
getKeys(): Promise<string[]>;
|
|
105
135
|
}
|
office-runtime/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-runtime",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.23",
|
|
4
4
|
"description": "TypeScript definitions for office-runtime",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime",
|
|
6
6
|
"license": "MIT",
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {},
|
|
42
42
|
"dependencies": {},
|
|
43
|
-
"typesPublisherContentHash": "
|
|
43
|
+
"typesPublisherContentHash": "c06f800870854a6de920aee4a8cad24e241d5a301e284b166484f0fbdae8357f",
|
|
44
44
|
"typeScriptVersion": "3.7"
|
|
45
45
|
}
|