Fix edit transform return type (#66)

siddharthvp · Oct 7, 2023 · 5388018 · 5388018
1 parent f37a887
commit 5388018
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/src/bot.ts b/src/bot.ts
@@ -119,6 +119,11 @@ export interface MwnOptions {
 	suppressInvalidDateWarning?: boolean;
 }
 
+export type EditTransform = (rev: {
+	content: string;
+	timestamp: string;
+}) => string | ApiEditPageParams | Promise<string | ApiEditPageParams>;
+
 type editConfigType = {
 	conflictRetries?: number;
 	suppressNochangeWarning?: boolean;
@@ -976,7 +981,7 @@ export class Mwn {
 	 */
 	async edit(
 		title: string | number,
-		transform: (rev: { content: string; timestamp: string }) => string | ApiEditPageParams,
+		transform: EditTransform,
 		editConfig?: editConfigType
 	): Promise<ApiEditResponse> {
 		editConfig = editConfig || this.options.editConfig;

diff --git a/src/page.ts b/src/page.ts
@@ -1,6 +1,6 @@
 import { MwnError } from './error';
 
-import type { Mwn, MwnTitle } from './bot';
+import type { Mwn, MwnTitle, EditTransform } from './bot';
 import type {
 	ApiDeleteParams,
 	ApiEditPageParams,
@@ -155,7 +155,7 @@ export interface MwnPage extends MwnTitle {
 	 * @see https://wikiwho.wmflabs.org/
 	 */
 	queryAuthors(): Promise<AuthorshipData>;
-	edit(transform: (rev: { content: string; timestamp: string }) => string | ApiEditPageParams): Promise<any>;
+	edit(transform: EditTransform): Promise<any>;
 	save(text: string, summary?: string, options?: ApiEditPageParams): Promise<any>;
 	newSection(header: string, message: string, additionalParams?: ApiEditPageParams): Promise<any>;
 	move(target: string, summary: string, options?: ApiMoveParams): Promise<any>;
@@ -651,7 +651,7 @@ export default function (bot: Mwn): MwnPageStatic {
 		/**** Post operations *****/
 		// Defined in bot.js
 
-		edit(transform: (rev: { content: string; timestamp: string }) => string | ApiEditPageParams) {
+		edit(transform: EditTransform) {
 			return bot.edit(this.toString(), transform);
 		}