Skip to content

Docs: document readingTime in the widget toolbox #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SandObserver merged 1 commit into from
Oct 20, 2026
Merged

Docs: document readingTime in the widget toolbox #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/content/docs/docs/create-a-widget/widget-page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ import { poll, fetchData, sparkline } from '/js/widget-toolbox.js?v=1';

- `widgetId()` returns this widget id from the frame URL.
- `fetchData(endpoint?, { params })` fetches `/api/widget-data/<id>` and returns the parsed JSON. Throws on a non-OK response. Each name in `params` must be listed in the manifest's [`params`](/docs/create-a-widget/manifest/#query-parameters).
- `readingTime(data)` returns when the service produced data that `fetchData` returned. While a slow refresh runs, the server can answer with the previous result, so use this, not `Date.now()`, for an "updated" label.
- `getConfig()` fetches this widget config, without secrets.

### Polling
Expand Down
Loading