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
20
21
22

export interface ApiDocsMethod {
  readonly name: string;
  readonly deprecated: string | undefined; // HTML
  readonly description: string; // HTML
  readonly remark: string | undefined; // HTML
  readonly since: string;
  readonly parameters: ApiDocsMethodParameter[];
  readonly returns: string;
  readonly throws: string | undefined; // HTML
  readonly signature: string; // HTML
  readonly examples: string; // HTML
  readonly refresh: (() => Promise<unknown[]>) | undefined;
  readonly seeAlsos: string[]; // HTML
  readonly sourcePath: string; // URL-Suffix
}

export interface ApiDocsMethodParameter {
  readonly name: string;
  readonly type: string | undefined;
  readonly default: string | undefined;
  readonly description: string; // HTML
}