Skip to main content

Function: waitForElectronAPI()

waitForElectronAPI(maxAttempts: number, baseDelay: number): Promise<void>

Defined in: src/stores/utils.ts:208

Utility function to wait for electronAPI to be available.

Parameters​

maxAttempts​

number = 50

Maximum number of polling attempts

baseDelay​

number = 100

Base delay in milliseconds for exponential backoff

Returns​

Promise<void>

Promise that resolves when electronAPI is available

Remarks​

Polls for the API with exponential backoff to handle timing issues during application startup. This is necessary because the preload script may not have finished executing when React components first mount.

Example​

try {
    await waitForElectronAPI();
    // Safe to use window.electronAPI
} catch (error) {
    logger.error("ElectronAPI not available", error as https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error);
}

Default Value​

maxAttempts - 50;

Default Value​

baseDelay - 100;

Throws​

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error when electronAPI is not available after maximum attempts