@dnlup/doc - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

CHANGELOG.md

@@ -5,2 +5,9 @@ # Changelog
 
+### [4.0.1](https://github.com/dnlup/doc/compare/v4.0.0...v4.0.1) (2021-03-17)
+
+
+### Bug Fixes
+
+* export errors ([e0d49a2](https://github.com/dnlup/doc/commit/e0d49a210beb5e493ba49d9a787b02dbf1cceedd))
+
 ## [4.0.0](https://github.com/dnlup/doc/compare/v4.0.0-3...v4.0.0) (2021-03-16)
@@ -7,0 +14,0 @@

index.d.ts

 import { Sampler, SamplerOptions } from './types/sampler'
+import errors = require('./types/errors')
 
@@ -11,2 +12,3 @@ declare function createSampler(options?: SamplerOptions): Sampler
 export { Sampler, SamplerOptions }
+export { errors }
 export * from './types/cpuMetric'
@@ -13,0 +15,0 @@ export * from './types/eventLoopDelayMetric'

index.js

@@ -5,2 +5,3 @@ 'use strict'
 const util = require('./lib/util')
+const errors = require('./lib/errors')
 
@@ -16,2 +17,3 @@ function createSampler (options = {}) {
 module.exports.Sampler = Sampler
+module.exports.errors = errors
 
@@ -18,0 +20,0 @@ Object.defineProperty(module.exports, 'eventLoopUtilizationSupported', {

package.json

 {
   "name": "@dnlup/doc",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Get usage and health data about your Node.js process",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -88,2 +88,4 @@ # doc
   * [`doc.gcFlagsSupported`](#docgcflagssupported)
+  * [`doc.errors`](#docerrors)
+- [License](#license)
 
@@ -397,3 +399,3 @@ <!-- tocstop -->
 
-The activity of the operation of type `major`. It's present only if `GCMEtric` has been created with the option `aggregate` equal to `true`.
+The activity of the operation of type `major`. It's present only if `GCMetric` has been created with the option `aggregate` equal to `true`.
 
@@ -406,3 +408,3 @@ See [`performanceEntry.kind`](https://nodejs.org/dist/latest-v12.x/docs/api/perf_hooks.html#perf_hooks_performanceentry_kind).
 
-The activity of the operation of type `minor`. It's present only if `GCMEtric` has been created with the option `aggregate` equal to `true`.
+The activity of the operation of type `minor`. It's present only if `GCMetric` has been created with the option `aggregate` equal to `true`.
 
@@ -415,3 +417,3 @@ See [`performanceEntry.kind`](https://nodejs.org/dist/latest-v12.x/docs/api/perf_hooks.html#perf_hooks_performanceentry_kind).
 
-The activity of the operation of type `incremental`. It's present only if `GCMEtric` has been created with the option `aggregate` equal to `true`.
+The activity of the operation of type `incremental`. It's present only if `GCMetric` has been created with the option `aggregate` equal to `true`.
 
@@ -424,3 +426,3 @@ See [`performanceEntry.kind`](https://nodejs.org/dist/latest-v12.x/docs/api/perf_hooks.html#perf_hooks_performanceentry_kind).
 
-The activity of the operation of type `weakCb`. It's present only if `GCMEtric` has been created with the option `aggregate` equal to `true`.
+The activity of the operation of type `weakCb`. It's present only if `GCMetric` has been created with the option `aggregate` equal to `true`.
 
@@ -435,3 +437,3 @@ See [`performanceEntry.kind`](https://nodejs.org/dist/latest-v12.x/docs/api/perf_hooks.html#perf_hooks_performanceentry_kind).
 
-The initialization doesn't require options. It is created internally by a [`GCMEtric`](#class-gcmetric).
+The initialization doesn't require options. It is created internally by a [`GCMetric`](#class-gcmetric).
 
@@ -491,3 +493,3 @@ #### `gcEntry.totalDuration`
 
-The initialization doesn't require options. It is created internally by a [`GCMEtric`](#class-gcmetric).
+The initialization doesn't require options. It is created internally by a [`GCMetric`](#class-gcmetric).
 
@@ -548,1 +550,14 @@ #### `gcAggregatedEntry.flags`
 It tells if the Node.js version in use supports [GC flags](https://nodejs.org/dist/latest-v12.x/docs/api/perf_hooks.html#perf_hooks_performanceentry_flags).
+
+### `doc.errors`
+
+In the `errors` object are exported all the custom errors used by the module.
+
+| Error | Error Code | Description |
+|-------|------------|-------------|
+| `InvalidArgumentError` | `DOC_ERR_INVALID_ARG` | An invalid option or argument was used |
+| `NotSupportedError` | `DOC_ERR_NOT_SUPPORTED` | A metric is not supported on the Node.js version used |
+
+## License
+
+[ISC](./LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

60652

increased by1.93%

Number of package files

24

increased by4.35%

Lines of code

936

increased by1.85%

Number of lines in readme file

556

increased by2.77%

No dependency changes