@sentry/types

What is @sentry/types?

The @sentry/types package provides TypeScript definitions for Sentry's JavaScript SDK. It includes types for Sentry's configuration options, event objects, and various interfaces used within Sentry's SDKs. This package is primarily used by developers to ensure type safety and autocompletion when working with Sentry in a TypeScript environment.

What are @sentry/types's main functionalities?

Event Interface

Defines the structure of an event that can be sent to Sentry. This includes the event's ID, level, timestamp, platform, and SDK information.

{
  event_id: string;
  level: 'error' | 'warning' | 'info' | 'debug';
  timestamp: number;
  platform: string;
  sdk: {
    name: string;
    version: string;
  };
}

Options Interface

Specifies the options for configuring the Sentry SDK. This includes the DSN (Data Source Name), breadcrumb limits, debug mode, integrations, and a beforeSend hook for event manipulation.

{
  dsn: string;
  maxBreadcrumbs: number;
  debug: boolean;
  integrations: Integration[];
  beforeSend: (event: Event) => Event | null;
}

Breadcrumb Interface

Describes a breadcrumb, which is a snapshot of data that describes what happened before an event. This includes the timestamp, message, category, level, and any additional data.

{
  timestamp: number;
  message: string;
  category: string;
  level: 'critical' | 'error' | 'warning' | 'info' | 'debug';
  data: Record<string, any>;
}

Other packages similar to @sentry/types

@types/node

Provides TypeScript definitions for Node.js. Similar to @sentry/types, it's used for type safety and autocompletion but focuses on Node.js' API rather than Sentry's.

typescript

The TypeScript language itself, which includes its compiler and type system. While not a direct alternative, it's the foundation that packages like @sentry/types build upon to provide type definitions for specific libraries.

@types/react

Offers TypeScript definitions for React. Similar to @sentry/types, it aids in developing React applications with TypeScript by providing types for React's API, but it doesn't relate to error monitoring or logging.

README

Sentry JavaScript SDK Types (DEPRECATED)

DEPRECATION NOTICE: The @sentry/types package is deprecated. All exports have been moved to @sentry/core. Import everything from @sentry/core instead.

Links

• Official SDK Docs

General

Common types used by the Sentry JavaScript SDKs.

Changelog

9.31.0

Important Changes

• feat(nextjs): Add option for auto-generated random tunnel route (#16626)

Adds an option to automatically generate a random tunnel route for the Next.js SDK. This helps prevent ad blockers and other tools from blocking Sentry requests by using a randomized path instead of the predictable /monitoring endpoint.

• feat(core): Allow to pass scope & client to getTraceData (#16633)

Adds the ability to pass custom scope and client parameters to the getTraceData function, providing more flexibility when generating trace data for distributed tracing.

Other Changes

• feat(core): Add support for x-forwarded-host and x-forwarded-proto headers (#16687)
• deps: Remove unused @sentry/opentelemetry dependency (#16677)
• deps: Update all bundler plugin instances to latest & allow caret ranges (#16641)
• feat(deps): Bump @prisma/instrumentation from 6.8.2 to 6.9.0 (#16608)
• feat(flags): add node support for generic featureFlagsIntegration and move utils to core (#16585)
• feat(flags): capture feature flag evaluations on spans (#16485)
• feat(pino): Add initial package for @sentry/pino-transport (#16652)
• fix: Wait for the correct clientWidth/clientHeight when showing Feedback Screenshot previews (#16648)
• fix(browser): Remove usage of Array.at() method (#16647)
• fix(core): Improve safeJoin usage in console logging integration (#16658)
• fix(google-cloud-serverless): Make CloudEvent type compatible (#16661)
• fix(nextjs): Fix lookup of instrumentation-client.js file (#16637)
• fix(node): Ensure graphql errors result in errored spans (#16678)