diff --git a/types/custom-functions-runtime/custom-functions-runtime-tests.ts b/types/custom-functions-runtime/custom-functions-runtime-tests.ts new file mode 100644 index 0000000000..d23e2e60e6 --- /dev/null +++ b/types/custom-functions-runtime/custom-functions-runtime-tests.ts @@ -0,0 +1,32 @@ +function ADD10(n: number) { + return n + 10; +} + +declare const CustomFunctionMappings: { + "addTen": ADD10(); +}; + +async function getStockValues(ticker: string, handler: CustomFunctions.StreamingHandler) { + const dollars = await (await fetch(`myService.com/prices/${ticker}`)).json(); + handler.setResult(dollars) +} + +async function getStockValuesOneTime(ticker: string, handler: CustomFunctions.CancelableHandler) { + var shouldStop = false; + handler.onCanceled = () => shouldStop = true; + await pause(1000); + + if (shouldStop) { + return null; + } + + const dollars = await (await fetch(`myService.com/prices/${ticker}`)).json(); + return dollars; +} + +async function getStockValuesNowWithNoCancelling(ticker: string) { + const dollars = await (await fetch(`myService.com/prices/${ticker}`)).json(); + return dollars; +} + +declare function pause(ms: number): Promise diff --git a/types/custom-functions-runtime/index.d.ts b/types/custom-functions-runtime/index.d.ts new file mode 100644 index 0000000000..3bab36de3c --- /dev/null +++ b/types/custom-functions-runtime/index.d.ts @@ -0,0 +1,30 @@ +// Type definitions for Custom Functions +// Project: http://dev.office.com +// Definitions by: OfficeDev , Michael Zlatkovsky , Michelle Scharlock +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.4 + +/* +office-js +Copyright (c) Microsoft Corporation +*/ + +declare const CustomFunctionMappings: { [key: string]: Function }; + +declare namespace CustomFunctions { + interface StreamingHandler extends CancelableHandler { + /* + * Sets the returned result for a streaming custom function. + * @beta + */ + setResult: (value: T) => void; + } + + interface CancelableHandler { + /* + * Handles what should occur when a custom function is canceled. + * @beta + */ + onCanceled: () => void; + } +} diff --git a/types/office-runtime/tsconfig.json b/types/custom-functions-runtime/tsconfig.json similarity index 100% rename from types/office-runtime/tsconfig.json rename to types/custom-functions-runtime/tsconfig.json diff --git a/types/office-runtime/tslint.json b/types/custom-functions-runtime/tslint.json similarity index 100% rename from types/office-runtime/tslint.json rename to types/custom-functions-runtime/tslint.json diff --git a/types/office-runtime/index.d.ts b/types/office-runtime/index.d.ts deleted file mode 100644 index 103ce050ea..0000000000 --- a/types/office-runtime/index.d.ts +++ /dev/null @@ -1,154 +0,0 @@ -// Type definitions for office-runtime -// Project: http://dev.office.com/ -// Definitions by: Michael Zlatskovsky , Michelle Scharlock -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// Typescript Version: 2.4 - -/* -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; - - /* - * Defines the AsyncStorage constant which allows asynchronous, global, and persistent key-value storage which can be used by Excel custom functions. - */ - - const AsyncStorage: AsyncStorage; - - /* - * 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 for your custom function. - * - */ - 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. - * - */ - interface Dialog { - /* - * @beta - * Method that closes a dialog box. - */ - close(): Promise; - } - - /* - * - * 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. - * - * - */ - onMessage?: (message: string, dialog?: Dialog) => void; - - /* - * @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. - * - * - */ - onRuntimeError?: (error: Error, dialog?: Dialog) => void; - } - }