Skip to content

Commit f338de3

Browse files
committed
remove commented code and add docs explaining the scope of the libdef
1 parent fd72cf6 commit f338de3

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

decls/custom-error-instance.js

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
// @flow
22

3+
// This is a partial libdef for custom-error-instance. It's filled out enough
4+
// such that it should work for the purposes of validated. However, the
5+
// documentation shows a potentially very complex API that might be hard to Flow
6+
// to express to a general purpose audience such as `flow-typed`.
37
declare module 'custom-error-instance' {
48
declare class CustomError extends Error {
59
constructor(messageOrProps?: string | Object, properties?: Object): this;
@@ -13,11 +17,6 @@ declare module 'custom-error-instance' {
1317
originalMessage: string;
1418
}
1519

16-
// declare type CustomErrorFactory = (
17-
// message?: string,
18-
// config?: Object,
19-
// ) => CustomError
20-
2120
declare type CustomErrorApi = (
2221
name?: string,
2322
parent?: CustomError,

0 commit comments

Comments
 (0)