Document wrapRemixHandleError

onurtemizkan · onurtemizkan · commit 1b5f701a021a · 2023-12-05T11:35:19.000Z
diff --git a/packages/remix/src/utils/instrumentServer.ts b/packages/remix/src/utils/instrumentServer.ts
@@ -72,7 +72,12 @@ async function extractResponseError(response: Response): Promise<unknown> {
 }
 
 /**
+ * Sentry utility to be used in place of `handleError` function of Remix v2
+ * Remix Docs: https://remix.run/docs/en/main/file-conventions/entry.server#handleerror
  *
+ * Should be used in `entry.server` like:
+ *
+ * export const handleError = Sentry.wrapRemixHandleError
  */
 export function wrapRemixHandleError(err: unknown, { request }: DataFunctionArgs): void {
   // We are skipping thrown responses here as they are either handled:

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,12 @@ async function extractResponseError(response: Response): Promise<unknown> {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`/**`
	`75`	+ * Sentry utility to be used in place of `handleError` function of Remix v2
	`76`	`+ * Remix Docs: https://remix.run/docs/en/main/file-conventions/entry.server#handleerror`
`75`	`77`	`*`
	`78`	+ * Should be used in `entry.server` like:
	`79`	`+ *`
	`80`	`+ * export const handleError = Sentry.wrapRemixHandleError`
`76`	`81`	`*/`
`77`	`82`	`export function wrapRemixHandleError(err: unknown, { request }: DataFunctionArgs): void {`
`78`	`83`	`// We are skipping thrown responses here as they are either handled:`