Skip to content

Commit

Permalink
Comments (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmingles committed Sep 20, 2024
1 parent 770ef5c commit 45de264
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/require-jsapi/src/dhe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ declare global {
export const iris: DheType;
}

/**
* Returns a CJS module that exports the Deephaven JS API. If the download flag
* is true, the API is downloaded from the server and saved to a local storage
* directory. If it is false, it will be returned from the local storage directory.
* @param serverUrl URL of the server to download the jsapi from
* @param download Whether to download the jsapi from the server
* @param storageDir Directory to save the downloaded jsapi and load it from
* @returns Default export of downloaded jsapi
*/
async function getDhe(
serverUrl: URL,
download: boolean,
Expand Down

0 comments on commit 45de264

Please sign in to comment.