random cleanup

Author: lobsterkatie

packages/minimal/src/index.ts

@@ -191,23 +191,21 @@ export function _callOnClient(method: string, ...args: any[]): void {
 }
 
 /**
- * Starts a new `Transaction` and returns it. This is the entry point to manual
- * tracing instrumentation.
+ * Starts a new `Transaction` and returns it. This is the entry point to manual tracing instrumentation.
  *
- * A tree structure can be built by adding child spans to the transaction, and
- * child spans to other spans. To start a new child span within the transaction
- * or any span, call the respective `.startChild()` method.
+ * A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a
+ * new child span within the transaction or any span, call the respective `.startChild()` method.
  *
- * Every child span must be finished before the transaction is finished,
- * otherwise the unfinished spans are discarded.
+ * Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.
  *
- * The transaction must be finished with a call to its `.finish()` method, at
- * which point the transaction with all its finished child spans will be sent to
- * Sentry.
+ * The transaction must be finished with a call to its `.finish()` method, at which point the transaction with all its
+ * finished child spans will be sent to Sentry.
  *
  * @param context Properties of the new `Transaction`.
  * @param customSampleContext Information given to the transaction sampling function (along with context-dependent
  * default values). See {@link Options.tracesSampler}.
+ *
+ * @returns The transaction which was just started
  */
 export function startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction {
   return callOnHub('startTransaction', { ...context }, customSampleContext);

packages/types/src/hub.ts

@@ -183,23 +183,21 @@ export interface Hub {
   startSpan(context: SpanContext): Span;
 
   /**
-   * Starts a new `Transaction` and returns it. This is the entry point to manual
-   * tracing instrumentation.
+   * Starts a new `Transaction` and returns it. This is the entry point to manual tracing instrumentation.
    *
-   * A tree structure can be built by adding child spans to the transaction, and
-   * child spans to other spans. To start a new child span within the transaction
-   * or any span, call the respective `.startChild()` method.
+   * A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a
+   * new child span within the transaction or any span, call the respective `.startChild()` method.
    *
-   * Every child span must be finished before the transaction is finished,
-   * otherwise the unfinished spans are discarded.
+   * Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.
    *
-   * The transaction must be finished with a call to its `.finish()` method, at
-   * which point the transaction with all its finished child spans will be sent to
-   * Sentry.
+   * The transaction must be finished with a call to its `.finish()` method, at which point the transaction with all its
+   * finished child spans will be sent to Sentry.
    *
    * @param context Properties of the new `Transaction`.
    * @param customSampleContext Information given to the transaction sampling function (along with context-dependent
    * default values). See {@link Options.tracesSampler}.
+   *
+   * @returns The transaction which was just started
    */
   startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction;
 }

packages/types/src/options.ts

@@ -105,6 +105,9 @@ export interface Options {
    */
   shutdownTimeout?: number;
 
+  /**
+   * Options which are in beta, or otherwise not guaranteed to be stable.
+   */
   _experiments?: {
     [key: string]: any;
   };

packages/types/src/request.ts

@@ -1,4 +1,6 @@
-/** JSDoc */
+/**
+ * Request data included in an event as sent to Sentry
+ */
 export interface Request {
   url?: string;
   method?: string;

packages/types/src/transaction.ts

@@ -65,12 +65,12 @@ export interface CustomSampleContext {
 export interface SampleContext extends CustomSampleContext {
   /**
    * Object representing the URL of the current page or worker script. Passed by default in a browser or service worker
-   * context
+   * context.
    */
   location?: Location | WorkerLocation;
 
   /**
-   * Object representing the incoming request to a node server. Passed by default in a node server context.
+   * Object representing the incoming request to a node server. Passed by default when using the TracingHandler.
    */
   request?: ExtractedNodeRequestData;
 }

packages/utils/src/misc.ts

@@ -157,12 +157,14 @@ export function consoleSandbox(callback: () => any): any {
     return callback();
   }
 
-  const originalConsole = global.console as ExtensibleConsole;
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  const originalConsole = (global as any).console as ExtensibleConsole;
   const wrappedLevels: { [key: string]: any } = {};
 
   // Restore all wrapped console methods
   levels.forEach(level => {
-    if (level in global.console && (originalConsole[level] as WrappedFunction).__sentry_original__) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    if (level in (global as any).console && (originalConsole[level] as WrappedFunction).__sentry_original__) {
       wrappedLevels[level] = originalConsole[level] as WrappedFunction;
       originalConsole[level] = (originalConsole[level] as WrappedFunction).__sentry_original__;
     }