@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

Links

• Official SDK Docs
• TypeDoc

General

Common types used by the Sentry JavaScript SDKs.

Changelog

8.10.0

Important Changes

• feat(remix): Migrate to opentelemetry-instrumentation-remix. (#12110)

You can now simplify your remix instrumentation by opting-in like this:

const Sentry = require('@sentry/remix');

Sentry.init({
  dsn: YOUR_DSN
  // opt-in to new auto instrumentation
  autoInstrumentRemix: true,
});

With this setup, you do not need to add e.g. wrapExpressCreateRequestHandler anymore. Additionally, the quality of the captured data improves. The old way to use @sentry/remix continues to work, but it is encouraged to use the new setup.

Other Changes

• feat(browser): Export thirdPartyErrorFilterIntegration from @sentry/browser (#12512)
• feat(feedback): Allow passing tags field to any feedback config param (#12197)
• feat(feedback): Improve screenshot quality for retina displays (#12487)
• feat(feedback): Screenshots don't resize after cropping (#12481)
• feat(node) add max lineno and colno limits (#12514)
• feat(profiling) add global profile context while profiler is running (#12394)
• feat(react): Add React version to events (#12390)
• feat(replay): Add url to replay hydration error breadcrumb type (#12521)
• fix(core): Ensure standalone spans respect sampled flag (#12533)
• fix(core): Use maxValueLength in extra error data integration (#12174)
• fix(feedback): Fix scrolling after feedback submission (#12499)
• fix(feedback): Send feedback rejects invalid responses (#12518)
• fix(nextjs): Update @rollup/plugin-commonjs (#12527)
• fix(node): Ensure status is correct for http server span errors (#12477)
• fix(node): UnifygetDynamicSamplingContextFromSpan (#12522)
• fix(profiling): continuous profile chunks should be in seconds (#12532)
• fix(remix): Add nativeFetch support for accessing request headers (#12479)
• fix(remix): Export no-op as captureRemixServerException from client SDK (#12497)
• ref(node) refactor contextlines to use readline (#12221)

Work in this release was contributed by @AndreyKovanov and @kiliman. Thank you for your contributions!