@microsoft/applicationinsights-web-basic 2.8.0-beta.2203-15 → 2.8.0-nightly.2204-04

package/dist/applicationinsights-web-basic.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-15
+ * Microsoft.ApplicationInsights, 2.8.0-nightly.2204-04
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -1486,15 +1486,39 @@ declare namespace ApplicationInsights {
     }
 
     interface IEnvelope extends ISerializable {
+        /**
+         * 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.
+         */
         ver: number;
+        /**
+         * Type name of telemetry data item.
+         */
         name: string;
+        /**
+         * Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.
+         */
         time: string;
+        /**
+         * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
+         */
         sampleRate: number;
+        /**
+         * Sequence field used to track absolute order of uploaded events.
+         */
         seq: string;
+        /**
+         * The application's instrumentation key. The key is typically represented as a GUID, but there are cases when it is not a guid. No code should rely on iKey being a GUID. Instrumentation key is case insensitive.
+         */
         iKey: string;
+        /**
+         * Key/value collection of context properties. See ContextTagKeys for information on available properties.
+         */
         tags: {
             [name: string]: any;
         };
+        /**
+         * Telemetry data item.
+         */
         data: any;
     }