Skip to content

docs(integrations): align examples with the actual SDK API#4

Merged
Polliog merged 1 commit into
mainfrom
docs/fix-integration-export-mismatches
Jun 30, 2026
Merged

docs(integrations): align examples with the actual SDK API#4
Polliog merged 1 commit into
mainfrom
docs/fix-integration-export-mismatches

Conversation

@Polliog

@Polliog Polliog commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Fixes documentation/API mismatches surfaced by the @logtide 0.11.0 export audit (logtide-dev/logtide-javascript#11). Each example now matches what the shipped packages actually expose.

Changes

  • nuxt: removed the non-existent clientDsn / clientEnabled / serverEnabled options; documented apiUrl + apiKey as a dsn alternative (now supported in 0.11.0); clarified that one config is shared by server + client.
  • nextjs: corrected LogtideErrorBoundary usage — it wraps a component tree with an optional fallback (there is no error prop); added the app/layout.tsx wiring.
  • react: fixed the fallback signature (it receives only error, there is no reset).
  • fastify: removed the non-existent onClose hook claim; documented the real onSend hook.
  • elysia: afterResponseonAfterHandle; removed the non-existent onStop hook (documented manual hub.flush() for graceful shutdown instead).
  • breadcrumbs: hub.addBreadcrumb() examples now include the required type and timestamp fields across angular, nextjs, nodejs, nuxt, react, solidjs, sveltekit and vue.

astro check passes (0 errors).

Note: the Node.js page intentionally documents @logtide/core (hub) and is self-consistent — left as-is.

Fixes documentation/API mismatches surfaced by the @logtide 0.11.0 export audit:

- nuxt: drop the non-existent clientDsn/clientEnabled/serverEnabled options;
  document apiUrl/apiKey as a dsn alternative; clarify single shared config
  for server + client.
- nextjs: fix LogtideErrorBoundary usage — it wraps a component tree with an
  optional fallback (no `error` prop); show layout wiring.
- react: fix the fallback signature (receives only `error`, no `reset`).
- fastify: remove the non-existent onClose hook; document onSend.
- elysia: afterResponse -> onAfterHandle; remove the non-existent onStop hook.
- all frontend/server pages: hub.addBreadcrumb examples now include the
  required `type` and `timestamp` fields (angular, nextjs, nodejs, nuxt, react,
  solidjs, sveltekit, vue).
@Polliog Polliog merged commit 00f5661 into main Jun 30, 2026
@Polliog Polliog deleted the docs/fix-integration-export-mismatches branch June 30, 2026 15:37
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.

1 participant