refactor: rename API methods for improved clarity #1334
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR refactors the Midscene API by renaming key methods for improved clarity and consistency:
aiAction()
→aiAct()
- More concise and clear naminglogScreenshot()
→recordToReport()
- Better reflects the method's purposeBreaking Changes
aiAction()
is nowaiAct()
logScreenshot()
is nowrecordToReport()
Backward Compatibility: The old
aiAction()
method is kept as a deprecated wrapper to maintain backward compatibility. Users should migrate toaiAct()
when convenient.Changes
Core Changes
aiAction()
toaiAct()
inpackages/core/src/agent/agent.ts
logScreenshot()
torecordToReport()
in agent implementationaiAction()
with JSDoc warningWeb Integration
aiAct
andrecordToReport
fixture typesDocumentation
Migration Guide
Before:
After:
Impact
aiAction()
)Test Plan
🤖 Generated with Claude Code