@sentry/types
Advanced tools
Package description
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.
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>;
}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.
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.
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.
Changelog
8.0.0-alpha.4
This is the fourth Alpha release of the v8 cycle, which includes a variety of breaking changes.
Read the in-depth migration guide to find out how to address any breaking changes in your code.
The minimum Node version required for the SDK is now 14.18.0.
@sentry/google-cloud-serverless (#11065)@sentry/serverless is no longer published, and is replaced by two new packages: @sentry/google-cloud-serverless and
@sentry/aws-serverless. These packages are now the recommended way to instrument serverless functions. See the
migration guide for more details.
The Browser SDK and CDN bundles now emits ES2017 compatible code and drops support for IE11. This also means that the
Browser SDKs (@sentry/browser, @sentry/react, @sentry/vue, etc.) requires the fetch API to be available in the
environment. If you need to support older browsers, please transpile your code to ES5 using babel or similar and add
required polyfills.
New minimum supported browsers:
startTransaction export (#11015)unmask and unblock (#11049)replaySession and errorSampleRates (#11045)spanRecorder and all related code (#10977)origin field on span start options (#11058)startSpan options (#11054)startTransaction & finishTransaction hooks (#11008)sentry field in Next.js config as a means of configuration (#10839)startChild deprecations (#10956)getRootSpan() does not rely on transaction (#10979)getSpanDescendants() everywhere (#10924)transactionName when route is resolved (#11043)name parameter (#11057)@sentry/astro to use OpenTelemetry (#10960)HttpContext integration class (#10987)scope.transactionName from root spans (#10991)startIdleSpan (#10934)__SENTRY__ singleton (#11034)__SENTRY__ (#11074)continueTrace to be callback-only (#11044)spanToJSON to handle OTEL spans (#10922)tunnelRoute option (#10959)setupFastifyErrorHandler utility (#11061)getRootSpan functionality (#11004)transactionName in React Router instrumentations (#11048)unstable_sentryVitePluginOptions for full Vite plugin customization (#10930)createReduxEnhancer on server (#11005)handled value in ErrorBoundary depending on fallback (#10989)addScopeListener to Scope interface (#10952)AttachmentType and use for envelope attachment_type property (#10946)allowSyntheticDefaultImports (#11073)startChild (#11056)scope.transactionName on pageload and navigation span creation (#10992)startChild() (#11047)http & undici (#11055)Work in this release contributed by @MFoster and @jessezhang91. Thank you for your contributions!
Readme
Common types used by the Sentry JavaScript SDKs.
FAQs
Types for all Sentry JavaScript SDKs
We found that @sentry/types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.