@dynatrace-sdk/app-utils - npm Package Compare versions

Comparing version 0.4.1 to 0.4.2

CHANGELOG.md

@@ -1,5 +0,11 @@
-# App utils
+# App Utils
 
 @dynatrace-sdk/app-utils
 
+## 0.4.2
+
+### Patch Changes
+
+- Improve documentation.
+
 ## 0.4.1
@@ -6,0 +12,0 @@

cjs/index.js

 /**
  * @license
- * Copyright 2023 Dynatrace LLC
+ * Copyright 2023-2024 Dynatrace LLC
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -5,0 +5,0 @@ * you may not use this file except in compliance with the License.

docs/DOCS.md

@@ -1,6 +0,6 @@
-# App utils
+# App Utils
 
 Utilities for app function executions.
 
-import NpmLogo from '@site/static/img/npm-logo.png';
+import NpmLogo from "@site/static/img/npm-logo.png";
 
@@ -14,4 +14,6 @@ <div class="row margin-bottom--md">
   </div>
-  <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/app-utils/v/0.4.1">v0.4.1</a>
+  <div class="col" style={{ textAlign: "right" }}>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/app-utils/v/0.4.2">
+      v0.4.2
+    </a>
   </div>
@@ -41,3 +43,4 @@ </div>
 <div class="padding-bottom--md">
-The functions namespace contains all the functions available as a convenience layer to communicate with functions.
+  The functions namespace contains all the functions available as a convenience
+  layer to communicate with functions.
 </div>
@@ -48,40 +51,23 @@
 <div class="padding-bottom--md">
-<strong>call(functionName,options?): <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#response_objects">Promise&lt;Response></a></strong>
+<strong>call(functionName,options?): Promise&lt;Response&gt;</strong>
 
-<div class="padding-left--md padding-bottom--md">
-A convenience layer for the user to communicate with an app function.
-</div>
-
 <div class="padding-left--md">
 
-**Parameters**
+A convenience layer for the user to communicate with an app function.
 
-<div class="padding-left--md padding-bottom--md">
-<strong>functionName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
-<div class="padding-left--md"></div>
 </div>
 
-<div class="padding-left--md padding-bottom--md">
-<strong>options?</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Object">Object</a>
-<div class="padding-left--md"></div>
-</div>
+#### Parameters
 
-<div class="padding-left--md padding-bottom--md">
-<strong>options.data?</strong>: Any
-<div class="padding-left--md"></div>
-</div>
+| Name                              | Type                                                                          | Description                            |
+| --------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------- |
+| functionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |                                        |
+| options                           | Object                                                                        | Optional options                       |
+| options.abortSignal               | AbortSignal                                                                   | An AbortSignal to set request's signal |
+| options.data                      | unknown                                                                       | An Payload of the call                 |
 
-<div class="padding-left--md padding-bottom--md">
-<strong>options.abortSignal?</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
-<div class="padding-left--md"></div>
-</div>
-
 #### Returns
 
-<div class="padding-left--md">
-A promise resolving a <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#response_objects">fetch response</a> object.
-</div>
+Response of a fetch call
 
 </div>
-
-</div>

esm/index.js

 /**
  * @license
- * Copyright 2023 Dynatrace LLC
+ * Copyright 2023-2024 Dynatrace LLC
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -5,0 +5,0 @@ * you may not use this file except in compliance with the License.

package.json

 {
   "name": "@dynatrace-sdk/app-utils",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "license": "Apache-2.0",
@@ -5,0 +5,0 @@ "description": "Utilities for app function executions.",

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

Worsened metrics

Total package byte prevSize

18122

decreased by-0.18%

No dependency changes