docs/.vitepress/components/api-docs/method.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

export interface Method {
  readonly name: string;
  readonly description: string; // HTML
  readonly parameters: MethodParameter[];
  readonly returns: string;
  readonly examples: string; // HTML
  readonly deprecated?: string; // HTML
  readonly since: string;
  readonly sourcePath: string; // URL-Suffix
  readonly seeAlsos: string[];
  readonly throws?: string; // HTML
}

export interface MethodParameter {
  readonly name: string;
  readonly type?: string;
  readonly default?: string;
  readonly description: string; // HTML
}