profiler-md 0.8.0 → 0.8.1

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/dist/index.d.mts CHANGED
@@ -1969,7 +1969,10 @@ declare const diffProfilesAsync: (base: ProfileInput<AsyncProfileData>, current:
1969
1969
  * format, a malformed profile, an invalid option.
1970
1970
  *
1971
1971
  * A failure the caller cannot fix throws a plain `Error` instead, because such
1972
- * a failure is a bug in this package.
1972
+ * a failure is a bug in this package. The exception is a parser failing on an
1973
+ * error it did not classify, which is either an input violating the format in
1974
+ * a way the parser does not check or a parser bug. That failure throws a
1975
+ * `ProfilerMdError` too, and `mayBeParserBug` identifies it.
1973
1976
  */
1974
1977
  declare class ProfilerMdError extends Error {
1975
1978
  constructor(message: string, options?: ErrorOptions);