@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 2.0.0-dev-rc.5.0.0.271717 to 2.0.0-dev-rc.5.0.0.272251

api-report/core-interfaces.alpha.api.md

@@ -348,5 +348,3 @@ ## Alpha API Report File for "@fluidframework/core-interfaces"
 export interface ITelemetryBaseLogger {
-    // (undocumented)
     minLogLevel?: LogLevel;
-    // (undocumented)
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -353,0 +351,0 @@ }

api-report/core-interfaces.beta.api.md

@@ -299,5 +299,3 @@ ## Beta API Report File for "@fluidframework/core-interfaces"
 export interface ITelemetryBaseLogger {
-    // (undocumented)
     minLogLevel?: LogLevel;
-    // (undocumented)
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -304,0 +302,0 @@ }

api-report/core-interfaces.public.api.md

@@ -299,5 +299,3 @@ ## Public API Report File for "@fluidframework/core-interfaces"
 export interface ITelemetryBaseLogger {
-    // (undocumented)
     minLogLevel?: LogLevel;
-    // (undocumented)
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -304,0 +302,0 @@ }

dist/logger.d.ts

@@ -68,3 +68,12 @@ /*!
 export interface ITelemetryBaseLogger {
+    /**
+     * Log a telemetry event, if it meets the appropriate log-level threshold (see {@link ITelemetryBaseLogger.minLogLevel}).
+     * @param event - The event to log.
+     * @param logLevel - The log level of the event. Default: {@link (LogLevel:variable).default}.
+     */
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
+    /**
+     * Minimum log level to be logged.
+     * @defaultValue {@link (LogLevel:variable).default}
+     */
     minLogLevel?: LogLevel;
@@ -71,0 +80,0 @@ }

lib/logger.d.ts

@@ -68,3 +68,12 @@ /*!
 export interface ITelemetryBaseLogger {
+    /**
+     * Log a telemetry event, if it meets the appropriate log-level threshold (see {@link ITelemetryBaseLogger.minLogLevel}).
+     * @param event - The event to log.
+     * @param logLevel - The log level of the event. Default: {@link (LogLevel:variable).default}.
+     */
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
+    /**
+     * Minimum log level to be logged.
+     * @defaultValue {@link (LogLevel:variable).default}
+     */
     minLogLevel?: LogLevel;
@@ -71,0 +80,0 @@ }

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-dev-rc.5.0.0.271717",
+  "version": "2.0.0-dev-rc.5.0.0.272251",
   "description": "Fluid object interfaces",
@@ -59,2 +59,3 @@ "homepage": "https://fluidframework.com",
     "@types/node": "^18.19.0",
+    "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
@@ -83,5 +84,10 @@ "eslint": "~8.55.0",
     "check:biome": "biome check . --formatter-enabled=true",
+    "check:exports": "concurrently \"npm:check:exports:*\"",
+    "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
+    "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
+    "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:prettier",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build": "npm run build:compile",
@@ -88,0 +94,0 @@ "ci:build:docs": "api-extractor run",

src/logger.ts

@@ -75,4 +75,13 @@ /*!
 export interface ITelemetryBaseLogger {
+	/**
+	 * Log a telemetry event, if it meets the appropriate log-level threshold (see {@link ITelemetryBaseLogger.minLogLevel}).
+	 * @param event - The event to log.
+	 * @param logLevel - The log level of the event. Default: {@link (LogLevel:variable).default}.
+	 */
 	send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
 
+	/**
+	 * Minimum log level to be logged.
+	 * @defaultValue {@link (LogLevel:variable).default}
+	 */
 	minLogLevel?: LogLevel;
@@ -79,0 +88,0 @@ }

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

Improved metrics

Total package byte prevSize

393901

increased by1%

Number of package files

137

increased by4.58%

Lines of code

3705

increased by1.53%

Published versions last two months

10

increased by11.11%

Worsened metrics

Dev dependency count

15

increased by7.14%

No dependency changes