Skip to content

FT-1860: Fix refreshInterval -> refreshPeriod in README#62

Merged
calthejuggler merged 1 commit intomainfrom
bugfix/ft-1860/fix-refresh-period-readme
Apr 20, 2026
Merged

FT-1860: Fix refreshInterval -> refreshPeriod in README#62
calthejuggler merged 1 commit intomainfrom
bugfix/ft-1860/fix-refresh-period-readme

Conversation

@calthejuggler
Copy link
Copy Markdown
Contributor

@calthejuggler calthejuggler commented Apr 20, 2026

Description

The README references refreshInterval in code examples and text, but the actual ContextOptions type uses refreshPeriod. This causes confusion for SDK users who copy-paste the examples.

Jira Issue FT-1860

Solution

Replaced all 4 occurrences of refreshInterval with refreshPeriod in README.md to match the actual type definition at src/context.ts:122.

Before & After

BEFORE:

const context = sdk.createContext(request, {
    refreshInterval: 5 * 60 * 1000
});

AFTER:

const context = sdk.createContext(request, {
    refreshPeriod: 5 * 60 * 1000
});

Other Changes

None.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Updated configuration examples to reflect the correct option name (refreshPeriod) for auto-refresh settings and other context creation configurations.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ea8c7010-7234-48d5-a6c2-5cc211f436b9

📥 Commits

Reviewing files that changed from the base of the PR and between 29fb24a and fd9001a.

📒 Files selected for processing (1)
  • README.md

Walkthrough

This pull request updates the README.md documentation by systematically replacing the refreshInterval option name with refreshPeriod across multiple code examples and their accompanying narrative text. The changes affect documentation for context auto-refresh configuration as well as per-request HTTP timeout and AbortSignal-based cancellation examples. No code logic or exported public entities were modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A name change whispers through the docs so bright,
From old refreshInterval to refreshPeriod's light,
The examples now aligned, the text rings true,
Clarity hopping forward, fresh and new! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: correcting the option name from refreshInterval to refreshPeriod in the README documentation, matching the raw summary and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch bugfix/ft-1860/fix-refresh-period-readme

Comment @coderabbitai help to get the list of available commands and usage tips.

@calthejuggler calthejuggler marked this pull request as ready for review April 20, 2026 10:15
@calthejuggler calthejuggler merged commit 5cc1617 into main Apr 20, 2026
3 checks passed
@calthejuggler calthejuggler deleted the bugfix/ft-1860/fix-refresh-period-readme branch April 20, 2026 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants