@xylabs/profile 5.0.84 → 5.0.86
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.
- package/README.md +19 -22
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
|
|
16
16
|
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
17
17
|
|
|
18
|
+
|
|
19
|
+
|
|
18
20
|
## Reference
|
|
19
21
|
|
|
20
22
|
**@xylabs/profile**
|
|
@@ -23,13 +25,17 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
|
23
25
|
|
|
24
26
|
## Type Aliases
|
|
25
27
|
|
|
26
|
-
|
|
28
|
+
| Type Alias | Description |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| [Profiler](#type-aliases/Profiler) | A record of named timing entries, where each key maps to an array of timestamps. |
|
|
27
31
|
|
|
28
32
|
## Functions
|
|
29
33
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
34
|
+
| Function | Description |
|
|
35
|
+
| ------ | ------ |
|
|
36
|
+
| [createProfiler](#functions/createProfiler) | Creates a new empty profiler instance. |
|
|
37
|
+
| [profile](#functions/profile) | Records a timestamp for the given profile name. |
|
|
38
|
+
| [profileReport](#functions/profileReport) | Generates a report of elapsed times for each profiled entry. |
|
|
33
39
|
|
|
34
40
|
### functions
|
|
35
41
|
|
|
@@ -56,24 +62,17 @@ Creates a new empty profiler instance.
|
|
|
56
62
|
***
|
|
57
63
|
|
|
58
64
|
```ts
|
|
59
|
-
function profile(profiler, name): void;
|
|
65
|
+
function profile(profiler: Profiler, name: string): void;
|
|
60
66
|
```
|
|
61
67
|
|
|
62
68
|
Records a timestamp for the given profile name.
|
|
63
69
|
|
|
64
70
|
## Parameters
|
|
65
71
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
[`Profiler`](#../type-aliases/Profiler)
|
|
69
|
-
|
|
70
|
-
The profiler instance to record into.
|
|
71
|
-
|
|
72
|
-
### name
|
|
73
|
-
|
|
74
|
-
`string`
|
|
75
|
-
|
|
76
|
-
The name of the timing entry.
|
|
72
|
+
| Parameter | Type | Description |
|
|
73
|
+
| ------ | ------ | ------ |
|
|
74
|
+
| `profiler` | [`Profiler`](#../type-aliases/Profiler) | The profiler instance to record into. |
|
|
75
|
+
| `name` | `string` | The name of the timing entry. |
|
|
77
76
|
|
|
78
77
|
## Returns
|
|
79
78
|
|
|
@@ -86,18 +85,16 @@ The name of the timing entry.
|
|
|
86
85
|
***
|
|
87
86
|
|
|
88
87
|
```ts
|
|
89
|
-
function profileReport(profiler): Record<string, number>;
|
|
88
|
+
function profileReport(profiler: Profiler): Record<string, number>;
|
|
90
89
|
```
|
|
91
90
|
|
|
92
91
|
Generates a report of elapsed times for each profiled entry.
|
|
93
92
|
|
|
94
93
|
## Parameters
|
|
95
94
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
[`Profiler`](#../type-aliases/Profiler)
|
|
99
|
-
|
|
100
|
-
The profiler instance to report on.
|
|
95
|
+
| Parameter | Type | Description |
|
|
96
|
+
| ------ | ------ | ------ |
|
|
97
|
+
| `profiler` | [`Profiler`](#../type-aliases/Profiler) | The profiler instance to report on. |
|
|
101
98
|
|
|
102
99
|
## Returns
|
|
103
100
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/profile",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.86",
|
|
4
4
|
"description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"profile",
|
|
@@ -43,8 +43,8 @@
|
|
|
43
43
|
"!**/*.test.*"
|
|
44
44
|
],
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@xylabs/ts-scripts-yarn3": "~7.4.
|
|
47
|
-
"@xylabs/tsconfig": "~7.4.
|
|
46
|
+
"@xylabs/ts-scripts-yarn3": "~7.4.16",
|
|
47
|
+
"@xylabs/tsconfig": "~7.4.16",
|
|
48
48
|
"typescript": "~5.9.3",
|
|
49
49
|
"vitest": "^4.0.18"
|
|
50
50
|
},
|