Merge pull request #41 from citrix-workspace/update-wait-for-sync

Add description and set param maxMinutesToWait as optional
citrix-workspace · Jul 16, 2021 · a587580 · a587580
2 parents 3b2a004 + 1f2c975
commit a587580
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 2 deletions.
diff --git a/dist/microappsAdmin.js b/dist/microappsAdmin.js
@@ -100,6 +100,8 @@ class MicroappsAdmin extends api_1.API {
      * Wait for syncronization and check the result of sync
      * @param {Function} getIntegration - Fetch status of integration
      * @param {string} synchronizationType - Set type of syncronization full/incremental
+     * @param {string} skipCheck - If running on newly created integration set this as true
+     * @param {number} maxMinutesToWait - Maxim time to wait in minutes
      */
     async waitForSync({ getIntegration, synchronizationType, integrationName = '', skipCheck = false, maxMinutesToWait = 9, }) {
         let jobRun;

diff --git a/src/microappsAdmin.ts b/src/microappsAdmin.ts
@@ -136,6 +136,8 @@ export class MicroappsAdmin extends API {
      * Wait for syncronization and check the result of sync
      * @param {Function} getIntegration - Fetch status of integration
      * @param {string} synchronizationType - Set type of syncronization full/incremental
+     * @param {string} skipCheck - If running on newly created integration set this as true
+     * @param {number} maxMinutesToWait - Maxim time to wait in minutes
      */
 
      async waitForSync({

diff --git a/src/types/microappsAdmin.ts b/src/types/microappsAdmin.ts
@@ -28,7 +28,7 @@ export type WaitForSync = {
     synchronizationType: string;
     integrationName?: string;
     skipCheck?: boolean,
-    maxMinutesToWait: number,
+    maxMinutesToWait?: number,
 };
 
 export type RunSynchronization = {

diff --git a/types/microappsAdmin.d.ts b/types/microappsAdmin.d.ts
@@ -30,6 +30,8 @@ export declare class MicroappsAdmin extends API {
      * Wait for syncronization and check the result of sync
      * @param {Function} getIntegration - Fetch status of integration
      * @param {string} synchronizationType - Set type of syncronization full/incremental
+     * @param {string} skipCheck - If running on newly created integration set this as true
+     * @param {number} maxMinutesToWait - Maxim time to wait in minutes
      */
     waitForSync({ getIntegration, synchronizationType, integrationName, skipCheck, maxMinutesToWait, }: WaitForSync): Promise<{
         jobState: string;

diff --git a/types/types/microappsAdmin.d.ts b/types/types/microappsAdmin.d.ts
@@ -24,7 +24,7 @@ export declare type WaitForSync = {
     synchronizationType: string;
     integrationName?: string;
     skipCheck?: boolean;
-    maxMinutesToWait: number;
+    maxMinutesToWait?: number;
 };
 export declare type RunSynchronization = {
     authInstance: AxiosInstance;