[@sentry/remix] `init` method is typed to return `void`, but actually returns the client

[haines]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/remix

SDK Version

8.33.1

Framework Version

2.12.1

Link to Sentry event

No response

Reproduction Example/SDK Setup

sentry-javascript/packages/remix/src/index.client.tsx

Line 32 in fcc3d2b

export function init(options: RemixOptions): Client | undefined {

sentry-javascript/packages/remix/src/index.server.ts

Line 180 in fcc3d2b

export function init(options: RemixOptions): NodeClient | undefined {

sentry-javascript/packages/remix/src/index.types.ts

Line 13 in fcc3d2b

export declare function init(options: RemixOptions): void;

Steps to Reproduce

I want to use our existing OpenTelemetry setup with Remix.

The guide says to import init from @sentry/node, but that won't set up the Sentry Remix SDK, will it?

But if I input init from @sentry/remix, it's typed to return void even though it actually returns a Sentry client.

Expected Result

I can use an existing OpenTelemetry setup with Remix without getting TypeScript compilation errors.

Actual Result

The types are wrong

[mydea]

Hey, thanks for raising this, you are right, this is incorrect - I will update this!

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #13938, which was included in the 8.35.0-beta.0 release.