Skip to content

Docs: show error-status checks in the widget data example #75

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 2, 2026
Merged

Docs: show error-status checks in the widget data example #75

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
9 changes: 6 additions & 3 deletions src/content/docs/docs/create-a-widget/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,18 @@ module.exports = async function (ctx) {
headers: apiKey ? { 'X-Api-Key': apiKey } : {},
timeout: 8000,
});
if (r.status === 401 || r.status === 403) ctx.fail('Auth failed (check API key)', { kind: ctx.KIND.AUTH });
if (r.status >= 400) ctx.fail('HTTP ' + r.status);
if (!r.data || !Array.isArray(r.data.items)) ctx.fail('Reply has no items');

return {
items: (r.data.items || []).slice(0, 10).map(i => ({ name: i.name })),
total: r.data.total ?? 0,
items: r.data.items.slice(0, 10).map(i => ({ name: i.name })),
total: r.data.total ?? r.data.items.length,
};
};
```

The return value is served at `/api/widget-data/<id>`. The template returns `{ error }` when the URL is missing. Use `ctx.fail` as shown, so the widget shows its failure state. See [Data](/docs/create-a-widget/data/).
The return value is served at `/api/widget-data/<id>`. Report every failure through `ctx.fail`, as the template does, so the widget shows its failure state. See [Data](/docs/create-a-widget/data/).

## 4. Page

Expand Down
Loading