diff --git a/types/office-runtime/index.d.ts b/types/office-runtime/index.d.ts index 3f57014bc9..ae86c01bcb 100644 --- a/types/office-runtime/index.d.ts +++ b/types/office-runtime/index.d.ts @@ -9,109 +9,117 @@ office-runtime Copyright (c) Microsoft Corporation */ +/** Office Runtime namespace */ declare namespace OfficeRuntime { + /** + * Enables you to pop up a web dialog box. + * @param url + * @param options + */ function displayWebDialog(url: string, options: DisplayWebDialogOptions): Promise; + /** + * Asynchronous, global, and persistent key-value storage that can be used by Excel Custom Functions. + */ const AsyncStorage: AsyncStorage; - - // tslint:disable-next-line:interface-name - /* - * Asynchronous, global, and persistent key-value storage that can be used by Excel Custom Functions. - * @beta - * - * @remarks - * Each add-in instance has its own storage partition, unique to a user and their device. - * - * The default amount of total storage allowed per add-in is 5MB. - * - * Each method listed below returns a Promise object. - * - */ + /** + * Asynchronous, global, and persistent key-value storage that can be used by Excel Custom Functions. + * @beta + * + * @remarks + * Each add-in instance has its own storage partition, unique to a user and their device. + * + * The default amount of total storage allowed per add-in is 5MB. + * + * Each method listed below returns a Promise object. + * + */ interface AsyncStorage { - /* - * @beta - * Retrieves an object based on a key and invokes a callback when finished. Returns a Promise. - */ - getItem(key: string, callback?: (error?: Error, result?: string) => void): Promise; - /* - * @beta - * Assigns the value for a key-value pair and invokes a callback when finished. Returns a Promise. - */ - setItem(key: string, value: string, callback?: (error?: Error) => void): Promise; - /* - * @beta - * Removes an item for specified key and invokes a callback when finished. Returns a Promise. - */ - removeItem(key: string, callback?: (error?: Error) => void): Promise; - /* - * @beta - * Erases all AsyncStorage. Returns a Promise. - */ - clear(callback?: (error?: Error) => void): Promise; - /* - * @beta - * Returns a Promise with all keys. - */ - getAllKeys(callback?: (error?: Error, keys?: string[]) => void): Promise; - /* - * @beta - * Stores multiple key-value pairs in one batch. Returns a Promise. When a key doesn't exist, returns null. - */ - multiSet(keyValuePairs: string[][], callback?: (errors?: Error[]) => void): Promise; - /* - * @beta - * Deletes a batch of keys, specified in the `keys` array. - */ - multiRemove(keys: string[], callback?: (errors?: Error[]) => void): Promise; - /* - * @beta - * Fetches a batch of keys, specified in the `keys` array. When a key doesn't exist, returns null. - */ - multiGet(keys: string[], callback?: (errors?: Error[], result?: string[][]) => void): Promise; + /** + * @beta + * Retrieves an object based on a key and invokes a callback when finished. Returns a Promise. + */ + getItem(key: string, callback?: (error?: Error, result?: string) => void): Promise; + /** + * @beta + * Assigns the value for a key-value pair and invokes a callback when finished. Returns a Promise. + */ + setItem(key: string, value: string, callback?: (error?: Error) => void): Promise; + /** + * @beta + * Removes an item for specified key and invokes a callback when finished. Returns a Promise. + */ + removeItem(key: string, callback?: (error?: Error) => void): Promise; + /** + * @beta + * Erases all AsyncStorage. Returns a Promise. + */ + clear(callback?: (error?: Error) => void): Promise; + /** + * @beta + * Returns a Promise with all keys. + */ + getAllKeys(callback?: (error?: Error, keys?: string[]) => void): Promise; + /** + * @beta + * Stores multiple key-value pairs in one batch. Returns a Promise. When a key doesn't exist, returns null. + */ + multiSet(keyValuePairs: string[][], callback?: (errors?: Error[]) => void): Promise; + /** + * @beta + * Deletes a batch of keys, specified in the `keys` array. + */ + multiRemove(keys: string[], callback?: (errors?: Error[]) => void): Promise; + /** + * @beta + * Fetches a batch of keys, specified in the `keys` array. When a key doesn't exist, returns null. + */ + multiGet(keys: string[], callback?: (errors?: Error[], result?: string[][]) => void): Promise; } /* - * @beta - * Object representing the dialog box. - */ + * @beta + * Object representing the dialog box. + */ interface Dialog { - /* - * @beta - * Method that closes a dialog box. - */ - close(): Promise; + /** + * @beta + * Method that closes a dialog box. + */ + close(): Promise; } - /* - * Provides options for how a dialog is displayed. - */ + + /** + * Provides options for how a dialog is displayed. + */ interface DisplayWebDialogOptions { - /* - * @beta - * Determines whether the dialog box displays as a popup (false) or within an IFrame (true). This setting is only applicable to custom functions running on Excel Online. - */ - displayInIFrame?: boolean; - /* - * @beta - * Defines the height of the dialog box as a percentage of the current display. - */ - height?: string; - /* - * @beta - * Defines the width of the dialog box as a percentage of the current display. - */ - width?: string; - /* - * @beta - * True if title is hidden from the dialog box. - */ - hideTitle?: boolean; - /* - * @beta - * Callback that is run when the dialog box is closed. - */ - onClose?: () => void; - /* - * @beta - * Callback that is run when the dialog box sends an error. - */ - onMessage?(message: string, dialog?: Dialog): void; + /** + * @beta + * Determines whether the dialog box displays as a popup (false) or within an IFrame (true). This setting is only applicable to custom functions running on Excel Online. + */ + displayInIFrame?: boolean; + /** + * @beta + * Defines the height of the dialog box as a percentage of the current display. + */ + height?: string; + /** + * @beta + * Defines the width of the dialog box as a percentage of the current display. + */ + width?: string; + /** + * @beta + * True if title is hidden from the dialog box. + */ + hideTitle?: boolean; + /* + * @beta + * Callback that is run when the dialog box is closed. + */ + onClose?: () => void; + /* + * @beta + * Callback that is run when the dialog box sends an error. + */ + onMessage?(message: string, dialog?: Dialog): void; } - } +} diff --git a/types/office-runtime/office-runtime-tests.ts b/types/office-runtime/office-runtime-tests.ts index 889665b3df..e8d15137b8 100644 --- a/types/office-runtime/office-runtime-tests.ts +++ b/types/office-runtime/office-runtime-tests.ts @@ -4,58 +4,59 @@ Copyright (c) Microsoft Corporation */ OfficeRuntime.AsyncStorage.getItem("foo", () => { - // perform an action -}); -OfficeRuntime.AsyncStorage.getItem("foo").then(value => console.log(value)); -OfficeRuntime.AsyncStorage.setItem("foo", "bar"); -OfficeRuntime.AsyncStorage.setItem("foo", "bar").then(error => console.log(error)); - -OfficeRuntime.AsyncStorage.removeItem("foo"); -OfficeRuntime.AsyncStorage.removeItem("foo", () => { - // perform an action -}); - -OfficeRuntime.AsyncStorage.clear(); -OfficeRuntime.AsyncStorage.clear(() => { // perform an action -}); + }); + OfficeRuntime.AsyncStorage.getItem("foo").then(value => console.log(value)); -OfficeRuntime.AsyncStorage.getAllKeys().then(keys => { - keys.forEach(item => console.log(item)); -}); + OfficeRuntime.AsyncStorage.setItem("foo", "bar"); + OfficeRuntime.AsyncStorage.setItem("foo", "bar").then(error => console.log(error)); -OfficeRuntime.AsyncStorage.getAllKeys((error, keys) => { - if (error) { - console.error(error); - } else { - keys.forEach(item => console.log(item)); + OfficeRuntime.AsyncStorage.removeItem("foo"); + OfficeRuntime.AsyncStorage.removeItem("foo", () => { + // perform an action + }); + + OfficeRuntime.AsyncStorage.clear(); + OfficeRuntime.AsyncStorage.clear(() => { + // perform an action + }); + + OfficeRuntime.AsyncStorage.getAllKeys().then(keys => { + keys.forEach(item => console.log(item)); + }); + + OfficeRuntime.AsyncStorage.getAllKeys((error, keys) => { + if (error) { + console.error(error); + } else { + keys.forEach(item => console.log(item)); + } + }); + + OfficeRuntime.AsyncStorage.multiSet( + [["username", "foo"], ["yearOfBirth", "2001"]], + errors => { + errors.filter(error => error != null).forEach(error => console.log(error)); + } + ); + + OfficeRuntime.AsyncStorage.multiRemove(["foo", "bar"]); + OfficeRuntime.AsyncStorage.multiRemove(["foo", "bar"]).then(value => console.log(value)); + + OfficeRuntime.AsyncStorage.multiGet(["username", "yearOfBirth"]).then( + values => { + console.log(values[0][1]); + console.log(values[1][1]); + } + ); + + OfficeRuntime.displayWebDialog("https://localhost:3000", { + displayInIFrame: false + }); + + OfficeRuntime.displayWebDialog("https://localhost:3000", { + onClose: () => { + console.log("closed"); } -}); - -OfficeRuntime.AsyncStorage.multiSet( - [["username", "foo"], ["yearOfBirth", "2001"]], - errors => { - errors.filter(error => error != null).forEach(error => console.log(error)); - } -); - -OfficeRuntime.AsyncStorage.multiRemove(["foo", "bar"]); -OfficeRuntime.AsyncStorage.multiRemove(["foo", "bar"]).then(value => console.log(value)); - -OfficeRuntime.AsyncStorage.multiGet(["username", "yearOfBirth"]).then( - values => { - console.log(values[0][1]); - console.log(values[1][1]); - } -); - -OfficeRuntime.displayWebDialog("https://localhost:3000", { - displayInIFrame: false -}); - -OfficeRuntime.displayWebDialog("https://localhost:3000", { - onClose: () => { - console.log("closed"); - } -}); + }); diff --git a/types/office-runtime/tsconfig.json b/types/office-runtime/tsconfig.json index f8559f2ebd..f98f2c1d1f 100644 --- a/types/office-runtime/tsconfig.json +++ b/types/office-runtime/tsconfig.json @@ -11,6 +11,7 @@ "strictFunctionTypes": true, "baseUrl": "../", "typeRoots": ["../"], + "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true, @@ -21,3 +22,4 @@ "office-runtime-tests.ts" ] } + diff --git a/types/office-runtime/tslint.json b/types/office-runtime/tslint.json index f93cf8562a..bbefc944d9 100644 --- a/types/office-runtime/tslint.json +++ b/types/office-runtime/tslint.json @@ -1,3 +1,4 @@ { "extends": "dtslint/dt.json" } +