From 0866ee9217e5e0b60e1c5f604e3576fb2604a3d5 Mon Sep 17 00:00:00 2001 From: Shinigami Date: Mon, 22 Aug 2022 23:38:15 +0800 Subject: docs: searchable api (#1253) --- docs/api/api-types.ts | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/api/api-types.ts (limited to 'docs/api/api-types.ts') diff --git a/docs/api/api-types.ts b/docs/api/api-types.ts new file mode 100644 index 00000000..f5dcd659 --- /dev/null +++ b/docs/api/api-types.ts @@ -0,0 +1,26 @@ +// 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; +} + +/** + * 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[]; +} -- cgit v1.2.3