modern-errors/examples/plugin/main.d.ts at main · ehmicky/modern-errors · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// import type { Info } from 'modern-errors'

// /**
//  * Options of `modern-errors-example`
//  */
// export interface Options {
//   /**
//    * Description of `exampleOption`.
//    *
//    * @default true
//    */
//   readonly exampleOption?: boolean
// }

/**
 * `modern-errors-example` plugin.
 *
 * Description of the plugin.
 */
declare const plugin: {
  name: 'example'

  // properties: (info: Info['properties']) => { exampleProp: unknown }

  // instanceMethods: {
  //   /**
  //    * Description of `ErrorClass.exampleMethod(error)`.
  //    *
  //    * @example
  //    * ```js
  //    * const value = ErrorClass.exampleMethod(error, arg)
  //    * ```
  //    */
  //   exampleMethod: (info: Info['instanceMethods'], arg: unknown) => unknown
  // }

  // staticMethods: {
  //   /**
  //    * Description of `ErrorClass.staticMethod()`.
  //    *
  //    * @example
  //    * ```js
  //    * const value = ErrorClass.staticMethod(arg)
  //    * ```
  //    */
  //   staticMethod: (info: Info['staticMethods'], arg: unknown) => unknown
  // }

  // getOptions: (input: Options, full: boolean) => Options

  // isOptions: (input: unknown) => boolean
}
export default plugin