FT-1860: Fix refreshInterval -> refreshPeriod in README#62
FT-1860: Fix refreshInterval -> refreshPeriod in README#62calthejuggler merged 1 commit intomainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis pull request updates the README.md documentation by systematically replacing the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Description
The README references
refreshIntervalin code examples and text, but the actualContextOptionstype usesrefreshPeriod. This causes confusion for SDK users who copy-paste the examples.Jira Issue FT-1860
Solution
Replaced all 4 occurrences of
refreshIntervalwithrefreshPeriodin README.md to match the actual type definition atsrc/context.ts:122.Before & After
BEFORE:
AFTER:
Other Changes
None.
Type of change
Checklist
Summary by CodeRabbit
refreshPeriod) for auto-refresh settings and other context creation configurations.