Skip to content

Commit

Permalink
docs: update readme (#48)
Browse files Browse the repository at this point in the history
issues:
* docs: update readme (#47)

commits:
* docs: update readme (0ec42d9)
  • Loading branch information
mnrendra authored Nov 13, 2024
1 parent caf37e8 commit 3334603
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,26 +54,20 @@ stackTrace(
)
```
## Utils
## Utilities
```javascript
import {
/**
* A utility to validate a name or a list of names of stack traces that need to be skipped.
*
* @see https://github.com/mnrendra/validate-skipped-stacks
*/
validateSkippedStacks
validateSkippedStacks // To validate a name or a list of names of stack traces that need to be skipped. More info: @see https://github.com/mnrendra/validate-skipped-stacks
} from '@mnrendra/stack-trace'
```
## Types
```typescript
import type {
CallSite, // NodeJS.CallSite
Options, // { limit?: number },
// @mnrendra/validate-skipped-stacks
SkippedStacks,
ValidSkippedStacks
Options, // @mnrendra/stack-trace options
SkippedStacks, // @mnrendra/validate-skipped-stacks input
ValidSkippedStacks // @mnrendra/validate-skipped-stacks output
} from '@mnrendra/stack-trace'
```
Expand Down

0 comments on commit 3334603

Please sign in to comment.