Skip to content

Commit

Permalink
docs: update README with new APIs.
Browse files Browse the repository at this point in the history
  • Loading branch information
asafkorem committed Dec 18, 2024
1 parent 648b08b commit 0286b64
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,25 @@ High-level overview of the API that Detox Copilot exposes:
init: (config: Config) => void;

/**
* Resets the Copilot instance.
* Must be called before each test to ensure a clean state (the Copilot uses the operations history as part of
* Checks if the Copilot has been initialized.
* @returns True if the Copilot has been initialized, false otherwise.
*/
isInitialized: () => boolean;

/**
* Start the Copilot instance.
* @note Must be called before each flow to ensure a clean state (the Copilot uses the operations history as part of
* its context).
*/
reset: () => void;
start: () => void;

/**
* Finalizes the flow and optionally saves temporary cache data to the main cache.
* If `isCacheDisabled` is true, the temporary cache will not be saved. False is the default value.
* @param isCacheDisabled
* @note This must be called after the flow is complete.
*/
end: (isCacheDisabled?: boolean) => void;

/**
* Performs a testing operation or series of testing operations in the app based on the given `steps`.
Expand Down

0 comments on commit 0286b64

Please sign in to comment.