@microsoft/applicationinsights-web-basic 3.0.0-beta.2210-03 → 3.0.0-beta.2210-06

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.32.0",
4
+ "toolVersion": "7.32.1",
5
5
  "schemaVersion": 1009,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Microsoft.ApplicationInsights, 3.0.0-beta.2210-03
2
+ * Microsoft.ApplicationInsights, 3.0.0-beta.2210-06
3
3
  * Copyright (c) Microsoft and contributors. All rights reserved.
4
4
  *
5
5
  * Microsoft Application Insights Team
@@ -1382,20 +1382,20 @@ declare namespace ApplicationInsights {
1382
1382
  queue: _InternalLogMessage[];
1383
1383
  /**
1384
1384
  * This method will throw exceptions in debug mode or attempt to log the error as a console warning.
1385
- * @param severity - {LoggingSeverity} - The severity of the log message
1386
- * @param message - {_InternalLogMessage} - The log message.
1385
+ * @param severity - The severity of the log message
1386
+ * @param message - The log message.
1387
1387
  */
1388
1388
  throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
1389
1389
  /**
1390
1390
  * This will write a warning to the console if possible
1391
- * @param message - {string} - The warning message
1391
+ * @param message - The warning message
1392
1392
  */
1393
1393
  warnToConsole(message: string): void;
1394
1394
  /**
1395
1395
  * This will write an error to the console if possible.
1396
1396
  * Provided by the default DiagnosticLogger instance, and internally the SDK will fall back to warnToConsole, however,
1397
1397
  * direct callers MUST check for its existence on the logger as you can provide your own IDiagnosticLogger instance.
1398
- * @param message - {string} - The error message
1398
+ * @param message - The error message
1399
1399
  */
1400
1400
  errorToConsole?(message: string): void;
1401
1401
  /**
@@ -1404,8 +1404,8 @@ declare namespace ApplicationInsights {
1404
1404
  resetInternalMessageCount(): void;
1405
1405
  /**
1406
1406
  * Logs a message to the internal queue.
1407
- * @param severity - {LoggingSeverity} - The severity of the log message
1408
- * @param message - {_InternalLogMessage} - The message to log.
1407
+ * @param severity - The severity of the log message
1408
+ * @param message - The message to log.
1409
1409
  */
1410
1410
  logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
1411
1411
  /**
@@ -1459,39 +1459,6 @@ declare namespace ApplicationInsights {
1459
1459
  setTraceFlags(newValue?: number): void;
1460
1460
  }
1461
1461
 
1462
- /**
1463
- * This interface identifies the config which can track changes
1464
- */
1465
- interface IDynamicConfigHandler<T extends IConfiguration> {
1466
- /**
1467
- * Unique Id for this config handler
1468
- */
1469
- readonly uid: string;
1470
- /**
1471
- * Link back to the configuration object that should be used to get/set values
1472
- */
1473
- cfg: T;
1474
- /**
1475
- * The logger instance to use to loger any issues
1476
- */
1477
- logger: IDiagnosticLogger;
1478
- /**
1479
- * Helper to call any listeners that are waiting to be notified
1480
- */
1481
- notify: () => void;
1482
- /**
1483
- * Watch and track changes for accesses to the current config anb
1484
- */
1485
- watch: (configHandler: WatcherFunction<T>) => IWatcherHandler<T>;
1486
- /**
1487
- * Set the value against the provided config/name with the value, the property
1488
- * will be converted to be dynamic (if not already) as long as the provided config
1489
- * is already a tracked dynamic object.
1490
- * @throws TypeError if the provided config is not a monitored dynamic config
1491
- */
1492
- set: <C, V>(theConfig: C, name: string, value: V) => V;
1493
- }
1494
-
1495
1462
  interface IEnvelope extends ISerializable {
1496
1463
  /**
1497
1464
  * Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.
@@ -2316,13 +2283,23 @@ declare namespace ApplicationInsights {
2316
2283
  }
2317
2284
 
2318
2285
  interface IWatchDetails<T extends IConfiguration> {
2286
+ /**
2287
+ * The current config object
2288
+ */
2319
2289
  cfg: T;
2320
- hdlr: IDynamicConfigHandler<T>;
2321
- }
2322
-
2323
- interface IWatcherHandler<T extends IConfiguration> extends IUnloadHook {
2324
- fn: WatcherFunction<T>;
2325
- rm: () => void;
2290
+ /**
2291
+ * Set the value against the provided config/name with the value, the property
2292
+ * will be converted to be dynamic (if not already) as long as the provided config
2293
+ * is already a tracked dynamic object.
2294
+ * @throws TypeError if the provided config is not a monitored dynamic config
2295
+ */
2296
+ set: <C, V>(theConfig: C, name: string, value: V) => V;
2297
+ /**
2298
+ * Set default values for the config if not present.
2299
+ * @param theConfig - The configuration object to set default on (if missing)
2300
+ * @param defaultValues - The default values to apply to the config
2301
+ */
2302
+ setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C>) => C;
2326
2303
  }
2327
2304
 
2328
2305
  const LoggingSeverity: EnumValue<typeof eLoggingSeverity>;