Merge pull request #1 from mattvick/bugfix/page-content-return-type

Fix Page content return type
mattvick · Dec 13, 2023 · ff15320 · ff15320
2 parents 79f22ec + 22b474a
commit ff15320
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -70,6 +70,17 @@ declare module 'wikijs' {
 		imageinfo: object[];
 	}
 
+	/**
+	 * Page section object
+	 *
+	 * @interface PageSection
+	 */
+	interface PageSection {
+		title: string;
+		content: string;
+		items?: PageSection[];
+	}
+
 	interface Result {
 		results: string[];
 		query: string;
@@ -116,12 +127,12 @@ declare module 'wikijs' {
 		categories(aggregated?: boolean, limit?: number): Promise<string[]>;
 
 		/**
-		 * Text content from page
+		 * Array of page sections
 		 *
-		 * @returns {Promise<string>}
+		 * @returns {Promise<PageSection[]>}
 		 * @memberof Page
 		 */
-		content(): Promise<string>;
+		content(): Promise<PageSection[]>;
 
 		/**
 		 * Geographical coordinates from page