Skip to content

Commit a2ac541

Browse files
committed
introduce diff option types
1 parent b9d65ff commit a2ac541

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

packages/node/src/client.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ import { logger, resolvedSyncPromise, stackParserFromOptions } from '@sentry/uti
55

66
import { eventFromMessage, eventFromUnknownInput } from './eventbuilder';
77
import { IS_DEBUG_BUILD } from './flags';
8-
import { NodeOptions } from './types';
8+
import { NodeClientOptions } from './types';
99

1010
/**
1111
* The Sentry Node SDK Client.
1212
*
1313
* @see NodeOptions for documentation on configuration options.
1414
* @see SentryClient for usage documentation.
1515
*/
16-
export class NodeClient extends BaseClient<NodeOptions> {
16+
export class NodeClient extends BaseClient<NodeClientOptions> {
1717
protected _sessionFlusher: SessionFlusher | undefined;
1818

1919
/**
2020
* Creates a new Node SDK instance.
2121
* @param options Configuration options for this SDK.
2222
*/
23-
public constructor(options: NodeOptions, transport: Transport, newTransport?: NewTransport) {
23+
public constructor(options: NodeClientOptions, transport: Transport, newTransport?: NewTransport) {
2424
options._metadata = options._metadata || {};
2525
options._metadata.sdk = options._metadata.sdk || {
2626
name: 'sentry.javascript.node',

packages/node/src/transports/setup.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, NewTransport, No
22
import { Transport, TransportOptions } from '@sentry/types';
33
import { makeDsn } from '@sentry/utils';
44

5-
import { NodeOptions } from '../types';
5+
import { NodeClientOptions } from '../types';
66
import { HTTPSTransport, HTTPTransport, makeNodeTransport } from '.';
77

88
/**
@@ -13,7 +13,7 @@ import { HTTPSTransport, HTTPTransport, makeNodeTransport } from '.';
1313
* this function will return a ready to use `NewTransport`.
1414
*/
1515
// TODO(v7): Adjust return value when NewTransport is the default
16-
export function setupNodeTransport(options: NodeOptions): { transport: Transport; newTransport?: NewTransport } {
16+
export function setupNodeTransport(options: NodeClientOptions): { transport: Transport; newTransport?: NewTransport } {
1717
if (!options.dsn) {
1818
// We return the noop transport here in case there is no Dsn.
1919
return { transport: new NoopTransport() };

packages/node/src/types.ts

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import { Options } from '@sentry/types';
1+
import { ClientOptions, Options } from '@sentry/types';
22

3-
/**
4-
* Configuration options for the Sentry Node SDK.
5-
* @see NodeClient for more information.
6-
*/
7-
export interface NodeOptions extends Options {
3+
export interface BaseNodeOptions {
84
/** Sets an optional server name (device name) */
95
serverName?: string;
106

11-
/** Maximum time in milliseconds to wait to drain the request queue, before the process is allowed to exit. */
12-
shutdownTimeout?: number;
13-
147
/** Set a HTTP proxy that should be used for outbound requests. */
158
httpProxy?: string;
169

@@ -23,3 +16,11 @@ export interface NodeOptions extends Options {
2316
/** Callback that is executed when a fatal global error occurs. */
2417
onFatalError?(error: Error): void;
2518
}
19+
20+
export interface NodeOptions extends Options, BaseNodeOptions {}
21+
22+
/**
23+
* Configuration options for the Sentry Node SDK.
24+
* @see NodeClient for more information.
25+
*/
26+
export interface NodeClientOptions extends ClientOptions, BaseNodeOptions {}

0 commit comments

Comments
 (0)