Skip to content

Commit 8477f97

Browse files
committed
add docs about minimal deletion
1 parent 215d57d commit 8477f97

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

MIGRATION.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,28 @@ Node.js version 6 has reached end of life in April 2019. For Sentry JavaScript S
1010
As far as SDK development goes, dropping support means no longer running integration tests for Node.js version 6, and also no longer handling edge cases specific to version 6.
1111
Running the new SDK version on Node.js v6 is therefore highly discouraged.
1212

13+
## Removal of `@sentry/minimal`
14+
15+
The `@sentry/minimal` package was deleted and it's functionality was moved to `@sentry/hub`. All exports from `@sentry/minimal` should be avaliable in `@sentry/hub` other than `_callOnClient` function which was removed.
16+
17+
```ts
18+
// New in v7:
19+
import {
20+
addBreadcrumb,
21+
captureException,
22+
configureScope,
23+
setTag,
24+
} from '@sentry/hub';
25+
26+
// Before:
27+
import {
28+
addBreadcrumb,
29+
captureException,
30+
configureScope,
31+
setTag,
32+
} from '@sentry/minimal';
33+
```
34+
1335
## Removal Of Old Platform Integrations From `@sentry/integrations` Package
1436

1537
The following classes will be removed from the `@sentry/integrations` package and can no longer be used:

packages/hub/src/exports.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ import {
1515
import { getCurrentHub, Hub } from './hub';
1616
import { Scope } from './scope';
1717

18+
// Note: All functions in this file are typed with a return value of `ReturnType<Hub[HUB_FUNCTION]>`,
19+
// where HUB_FUNCTION is some method on the Hub class.
20+
//
21+
// This is done to make sure the top level SDK methods stay in sync with the hub methods.
22+
// Although every method here has an explicit return type, some of them (that map to void returns) do not
23+
// contain `return` keywords. This is done to save on bundle size, as `return` is not minifiable.
24+
1825
/**
1926
* Captures an exception event and sends it to Sentry.
2027
*

0 commit comments

Comments
 (0)