Added comments, got rid of extra *s

This commit is contained in:
Michelle Scharlock
2018-09-13 10:41:05 -07:00
committed by GitHub
parent ac169cae54
commit 7482d84a2c
+29 -18
View File
@@ -9,12 +9,23 @@ office-runtime
Copyright (c) Microsoft Corporation
*/
/*
OfficeRuntime defines a new runtime which can be used by Excel custom functions.
*/
declare namespace OfficeRuntime {
/*
A function which allows you to use a dialog box in Office Runtime, which can be used by Excel custom functions.
*/
function displayWebDialog(url: string, options: DisplayWebDialogOptions): Promise<Dialog>;
/*
* Defines the AsyncStorage constant which allows asynchronous, global, and persistent key-value storage which 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
*
@@ -27,50 +38,50 @@ declare namespace OfficeRuntime {
*
*/
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<string>;
/**
/*
* @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<void>;
/**
/*
* @beta
* Removes an item for specified key and invokes a callback when finished. Returns a Promise.
*
*
*/
removeItem(key: string, callback?: (error?: Error) => void): Promise<void>;
/**
/*
* @beta
* Erases all AsyncStorage. Returns a Promise.
*
*/
clear(callback?: (error?: Error) => void): Promise<void>;
/**
/*
* @beta
* Returns a Promise with all keys for your custom function.
*
*/
getAllKeys(callback?: (error?: Error, keys?: string[]) => void): Promise<string[]>;
/**
/*
* @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<void>;
/**
/*
* @beta
* Deletes a batch of keys, specified in the `keys` array.
*
*/
multiRemove(keys: string[], callback?: (errors?: Error[]) => void): Promise<void>;/**
/**
/*
* @beta
* Fetches a batch of keys, specified in the `keys` array. When a key doesn't exist, returns null.
*
@@ -78,46 +89,46 @@ declare namespace OfficeRuntime {
multiGet(keys: string[], callback?: (errors?: Error[], result?: string[][]) => void): Promise<string[][]>;
}
/**
/*
* @beta
* Object representing the dialog box.
*
*/
interface Dialog {
/**
/*
* @beta
* Method that closes a dialog box.
*/
close(): Promise<void>;
}
/**
/*
*
* 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
* Callback that is run when the dialog box sends a message to its parent.
*
@@ -125,7 +136,7 @@ declare namespace OfficeRuntime {
*/
onMessage?: (message: string, dialog?: Dialog) => void;
/**
/*
* @beta
* Callback that is run when the dialog box is closed.
*
@@ -133,7 +144,7 @@ declare namespace OfficeRuntime {
*/
onClose?: () => void;
/**
/*
* @beta
* Callback that is run when the dialog box sends an error.
*