@minecraft/debug-utilities 1.0.0-beta.1.21.40-preview.25 → 1.0.0-beta.1.21.50-preview.24

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.
Files changed (3) hide show
  1. package/README.md +2 -0
  2. package/index.d.ts +36 -1
  3. package/package.json +2 -3
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # `@minecraft/debug-utilities`
2
2
 
3
+ Contains debug utility functions.
4
+
3
5
  ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
4
6
 
5
7
  See full documentation for this module here:
package/index.d.ts CHANGED
@@ -9,6 +9,7 @@
9
9
  /**
10
10
  * @beta
11
11
  * @packageDocumentation
12
+ * Contains debug utility functions.
12
13
  *
13
14
  * Manifest Details
14
15
  * ```json
@@ -20,8 +21,42 @@
20
21
  *
21
22
  */
22
23
  import * as minecraftcommon from '@minecraft/common';
23
- import * as minecraftserver from '@minecraft/server';
24
+ export interface RuntimeStats {
25
+ arrayCount: number;
26
+ atomCount: number;
27
+ atomSize: number;
28
+ fastArrayCount: number;
29
+ fastArrayElementCount: number;
30
+ functionCodeSize: number;
31
+ functionCount: number;
32
+ functionLineCount: number;
33
+ functionSize: number;
34
+ memoryAllocatedCount: number;
35
+ memoryAllocatedSize: number;
36
+ memoryUsedCount: number;
37
+ memoryUsedSize: number;
38
+ objectCount: number;
39
+ objectSize: number;
40
+ propertyCount: number;
41
+ propertySize: number;
42
+ stringCount: number;
43
+ stringSize: number;
44
+ }
45
+
24
46
  /**
47
+ * @remarks
48
+ * Collect memory stats for script runtimes.
49
+ *
50
+ * @returns
51
+ * RuntimeStats object.
52
+ */
53
+ export function collectRuntimeStats(): RuntimeStats;
54
+ /**
55
+ * @remarks
56
+ * Disable watchdog slow and spike warnings per plugin.
57
+ *
58
+ * @param disable
59
+ * Flag to disable or re-enable warnings.
25
60
  * @throws This function can throw errors.
26
61
  */
27
62
  export function disableWatchdogTimingWarnings(disable: boolean): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/debug-utilities",
3
- "version": "1.0.0-beta.1.21.40-preview.25",
3
+ "version": "1.0.0-beta.1.21.50-preview.24",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {
@@ -13,8 +13,7 @@
13
13
  }
14
14
  ],
15
15
  "dependencies": {
16
- "@minecraft/common": "^1.0.0",
17
- "@minecraft/server": "^1.8.0"
16
+ "@minecraft/common": "^1.0.0"
18
17
  },
19
18
  "license": "MIT"
20
19
  }