@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
49 lines • 1.53 kB
TypeScript
import { State } from '../../shared/State';
export type Startup = {
/**
* Check for updates that need applying
* @returns {Promise<Updates>} true if there are updates that need to be applied, false otherwise
*/
checkForUpdates(): Promise<Updates>;
/**
* Apply updates
* @param {boolean} wait wait for the operation to complete or not
* @param {number} timeout timeout in milliseconds
* @returns {Promise<boolean>} true if successful, false otherwise
*/
applyUpdates(wait: boolean, timeout?: number): Promise<boolean>;
};
declare const _default: (state: State) => Startup;
export default _default;
/**
* Updates that need to be applied.
*/
export interface Updates {
/**
* Array of secrets that need applying
*/
secrets?: unknown[];
/**
* Array of variables that need applying
*/
variables?: unknown[];
}
/**
* Check for updates that need applying
* @returns {Promise<boolean>} true if there are updates that need to be applied, false otherwise
*/
export declare function checkForUpdates({ state, }: {
state: State;
}): Promise<Updates>;
/**
* Apply updates
* @param {boolean} wait wait for the operation to complete or not
* @param {number} timeout timeout in milliseconds
* @returns {Promise<boolean>} true if successful, false otherwise
*/
export declare function applyUpdates({ wait, timeout, state, }: {
wait: boolean;
timeout?: number;
state: State;
}): Promise<boolean>;
//# sourceMappingURL=StartupOps.d.ts.map