docs/api/api-types.ts


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

// These interfaces are copied over from https://github.com/vuejs/docs/blob/main/src/api/api.data.ts

/**
 * Represents a link to e.g. a Faker-Module method within the API search index page.
 */
export interface APIHeader {
  anchor: string;
  text: string;
  deprecated: boolean;
}

/**
 * Represents a container for e.g. a Faker-Module within the API search index page.
 */
export interface APIItem {
  text: string;
  link: string;
  headers: APIHeader[];
}

/**
 * Represents a whole section within the API search index page.
 */
export interface APIGroup {
  text: string;
  items: APIItem[];
}