@xylabs/function-name 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.
Files changed (2) hide show
  1. package/README.md +9 -7
  2. package/package.json +5 -5
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/function-name**
@@ -23,7 +25,9 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
23
25
 
24
26
  ## Functions
25
27
 
26
- - [functionName](#functions/functionName)
28
+ | Function | Description |
29
+ | ------ | ------ |
30
+ | [functionName](#functions/functionName) | Returns the name of the calling function by inspecting the stack trace. |
27
31
 
28
32
  ### functions
29
33
 
@@ -34,18 +38,16 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
34
38
  ***
35
39
 
36
40
  ```ts
37
- function functionName(depth?): string;
41
+ function functionName(depth?: number): string;
38
42
  ```
39
43
 
40
44
  Returns the name of the calling function by inspecting the stack trace.
41
45
 
42
46
  ## Parameters
43
47
 
44
- ### depth?
45
-
46
- `number` = `2`
47
-
48
- The stack frame depth to read the function name from (default: 2).
48
+ | Parameter | Type | Default value | Description |
49
+ | ------ | ------ | ------ | ------ |
50
+ | `depth` | `number` | `2` | The stack frame depth to read the function name from (default: 2). |
49
51
 
50
52
  ## Returns
51
53
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/function-name",
3
- "version": "5.0.84",
3
+ "version": "5.0.86",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "function",
@@ -43,12 +43,12 @@
43
43
  "!**/*.test.*"
44
44
  ],
45
45
  "dependencies": {
46
- "@xylabs/error": "~5.0.84",
47
- "@xylabs/typeof": "~5.0.84"
46
+ "@xylabs/error": "~5.0.86",
47
+ "@xylabs/typeof": "~5.0.86"
48
48
  },
49
49
  "devDependencies": {
50
- "@xylabs/ts-scripts-yarn3": "~7.4.13",
51
- "@xylabs/tsconfig": "~7.4.13",
50
+ "@xylabs/ts-scripts-yarn3": "~7.4.16",
51
+ "@xylabs/tsconfig": "~7.4.16",
52
52
  "typescript": "~5.9.3",
53
53
  "vitest": "~4.0.18"
54
54
  },