Skip to content

Commit 3115cc4

Browse files
change jsdoc
1 parent 44f5bbb commit 3115cc4

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

packages/browser/src/utils/ipAddress.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import type { Session, SessionAggregates, User } from '@sentry/core';
22

3+
// By default, we want to infer the IP address, unless this is explicitly set to `null`
4+
// We do this after all other processing is done
5+
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
6+
37
/**
48
* @internal
5-
* By default, we want to infer the IP address, unless this is explicitly set to `null`
6-
* We do this after all other processing is done
7-
* If `ip_address` is explicitly set to `null` or a value, we leave it as is
89
*/
910
export function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
1011
if (objWithMaybeUser.user?.ip_address === undefined) {
@@ -17,8 +18,6 @@ export function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null })
1718

1819
/**
1920
* @internal
20-
* Adds the `ip_address` attribute to the session if it is not explicitly set to `null` or a value.
21-
* @param session The session to add the `ip_address` attribute to.
2221
*/
2322
export function addAutoIpAddressToSession(session: Session | SessionAggregates): void {
2423
if ('aggregates' in session) {

0 commit comments

Comments
 (0)