vscode-extension-telemetry - npm Package Compare versions

Comparing version 0.3.1 to 0.3.2

lib/telemetryReporter.d.ts

@@ -12,7 +12,35 @@ /*---------------------------------------------------------
 export default class TelemetryReporter {
+	/**
+	 * @param extensionId The id of your extension
+	 * @param extensionVersion The version of your extension
+	 * @param key The app insights key
+	 * @param firstParty Whether or not the telemetry is first party (i.e from Microsoft / GitHub)
+	 */
 	constructor(extensionId: string, extensionVersion: string, key: string, firstParty?: boolean);
+
+	/**
+	 * Sends a telemetry event with the given properties and measurements
+	 * @param eventName The name of the event
+	 * @param properties The set of properties to add to the event in the form of a string key value pair
+	 * @param measurements The set of measurements to add to the event in the form of a string key  number value pair
+	 */
 	sendTelemetryEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
+
+	/**
+	 * Sends a telemetry error event with the given properties, measurements, and errorProps
+	 * @param eventName The name of the event
+	 * @param properties The set of properties to add to the event in the form of a string key value pair
+	 * @param measurements The set of measurements to add to the event in the form of a string key  number value pair
+	 * @param errorProps A list of case sensitive properties to drop, if excluded we drop all properties but still send the event
+	 */
 	sendTelemetryErrorEvent(eventName: string, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements, errorProps?: string[]): void;
+
+	/**
+	 * Sends an exception which includes the error stack, properties, and measurements
+	 * @param error The error to send
+	 * @param properties The set of properties to add to the event in the form of a string key value pair
+	 * @param measurements The set of measurements to add to the event in the form of a string key  number value pair
+	 */
 	sendTelemetryException(error: Error, properties?: TelemetryEventProperties, measurements?: TelemetryEventMeasurements): void;
 	dispose(): Promise<any>;
 }

package.json

 {
   "name": "vscode-extension-telemetry",
   "description": "A module for first party microsoft extensions to report consistent telemetry.",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "author": {
@@ -6,0 +6,0 @@ "name": "Microsoft Corporation"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

436026

increased by0.33%

Lines of code

1680

increased by1.51%

Number of medium supply chain risk alerts

15

decreased by-6.25%

No dependency changes