merge: v1.4.3

README.md

@@ -65,6 +65,7 @@ import {
 ```typescript
 import type {
   CallSite, // NodeJS.CallSite
+  Func, // (...args: any[]) => any
   Options, // @mnrendra/stack-trace options
   SkippedStacks, // @mnrendra/validate-skipped-stacks input
   ValidSkippedStacks // @mnrendra/validate-skipped-stacks output

src/index.ts

@@ -8,6 +8,7 @@ export {
 
 export type {
   CallSite,
+  Func,
   Options
 } from './types'
 

src/main.ts

@@ -1,13 +1,13 @@
-import type { CallSite, Options } from './types'
+import type { CallSite, Func, Options } from './types'
 
 import { createTarget } from './utils'
 
 /**
  * A utility to enable stack tracing of the `NodeJs.CallSite` object, allowing
  * dynamic tracing of invocations.
  *
- * @param {Function|null} [targetFunction] - An optional function to serve as
- * the target.
+ * @param {Func|null} [targetFunction] - An optional function to serve as the
+ * target.
  * @param {Options} [options] - An optional set of options to configure the
  * output.
  *
@@ -16,7 +16,7 @@ import { createTarget } from './utils'
  * @see https://github.com/mnrendra/stack-trace#readme
  */
 const main = (
-  targetFunction?: Function | null,
+  targetFunction?: Func | null,
   {
     limit = 10
   }: Options = {

src/types/Func.ts

@@ -0,0 +1 @@
+export type Func = (...args: any[]) => any

src/types/Options.ts

@@ -2,10 +2,13 @@ export interface Options {
   /**
    * The `Error.stackTraceLimit` property specifies the number of stack frames
    * collected by a stack trace.
-   * 
-   * The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
    *
-   * If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
+   * The default value is `10` but may be set to any valid JavaScript number.
+   * Changes will affect any stack trace captured after the value has been
+   * changed.
+   *
+   * If set to a non-number value, or set to a negative number, stack traces
+   * will not capture any frames.
    *
    * @default 10
    *

src/types/index.ts

@@ -1,9 +1,11 @@
 import type { CallSite } from './CallSite'
+import type { Func } from './Func'
 import type { Options } from './Options'
 import type { Target } from './Target'
 
 export type {
   CallSite,
+  Func,
   Options,
   Target
 }