add tests for async and simplified return type for async functions

Author: marle3003

types/mokapi/index.d.ts

@@ -122,7 +122,7 @@ export interface EventHandler {
  *   })
  * }
  */
-export type HttpEventHandler = (request: HttpRequest, response: HttpResponse) => void | Promise<void>;
+export type HttpEventHandler = (request: HttpRequest, response: HttpResponse) => void;
 
 /**
  * HttpRequest is an object used by HttpEventHandler that contains request-specific
@@ -204,7 +204,7 @@ export interface Url {
  *   })
  * }
  */
-export type KafkaEventHandler = (message: KafkaEventMessage) => void | Promise<void>;
+export type KafkaEventHandler = (message: KafkaEventMessage) => void;
 
 /**
  * KafkaEventMessage is an object used by KafkaEventHandler that contains Kafka-specific message data.
@@ -243,7 +243,7 @@ export interface KafkaEventMessage {
  *   })
  * }
  */
-export type LdapEventHandler = (request: LdapSearchRequest, response: LdapSearchResponse) => void | Promise<void>;
+export type LdapEventHandler = (request: LdapSearchRequest, response: LdapSearchResponse) => void;
 
 /**
  * LdapSearchRequest is an object used by LdapEventHandler that contains request-specific data.
@@ -343,7 +343,7 @@ export enum LdapResultStatus {
     SizeLimitExceeded = 4,
 }
 
-export type SmtpEventHandler = (record: SmtpEventMessage) => void | Promise<void>;
+export type SmtpEventHandler = (record: SmtpEventMessage) => void;
 
 export interface SmtpEventMessage {
     server: string;
@@ -456,8 +456,57 @@ export interface JSONObject {
     [key: string]: JSONValue;
 }
 
+/**
+ * Specifies the date-time format defined in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339).
+ * This constant can be used when defining or validating datetime strings.
+ * 
+ * @example
+ * const date = new Date().toISOString()
+ * if (isValidDate(date, RFC3339)) {
+ *   // do something
+ * }
+ */
 export const RFC3339 = "RFC3339";
 
+/**
+ * Applies a patch object to a target object. Only properties that are explicitly defined in the patch
+ * are applied. This includes nested objects. Properties marked with `Delete` will be removed.
+ * 
+ * This function is especially useful when working with generated mock data in Mokapi that you want to override
+ * or refine with specific values.
+ * 
+ * https://mokapi.io/docs/javascript-api/mokapi/patch
+ * 
+ * @param target The original object or value to be patched.
+ * @param patch The patch object or value. Only defined values are applied; undefined values are ignored. Use `Delete` to remove fields.
+ * @returns A new object or value with the patch applied.
+ * 
+ * @example
+ * const result = patch({ name: "foo", age: 42 }, { name: "bar" })
+ * // result: { name: "bar", age: 42 }
+ * 
+ * @example
+ * const result = patch({ name: "foo", meta: { version: 1 } }, { meta: { version: 2 } })
+ * // result: { name: "foo", meta: { version: 2 } }
+ * 
+ * @example
+ * const result = patch({ name: "foo", age: 42 }, { age: Delete })
+ * // result: { name: "foo" }
+ */
 export function patch(target: any, patch: any): any;
 
+/**
+ * Special marker used with the `patch` function to indicate a property should be removed.
+ * 
+ * When used as a value inside a patch object, the corresponding property will be deleted
+ * from the result.
+ * 
+ * This is useful when refining or overriding mock data in a script while keeping validation logic intact.
+ * 
+ * https://mokapi.io/docs/javascript-api/mokapi/patch#delete
+ * 
+ * @example
+ * const result = patch({ name: "foo", age: 42 }, { age: Delete })
+ * // result: { name: "foo" }
+ */
 export const Delete: unique symbol;

types/mokapi/test/mokapi-tests.ts

@@ -44,6 +44,7 @@ on("ldap", (req: LdapSearchRequest, res: LdapSearchResponse) => {});
 on("http", handler, "");
 on("http", handler, {});
 on("http", handler, { tags: { foo: "bar" } });
+on("http", async () => {});
 
 // @ts-expect-error
 every(12, () => {});
@@ -58,6 +59,7 @@ every("12m", () => {}, { times: 3 });
 // @ts-expect-error
 every("12m", () => {}, { runFirstTimeImmediately: 1 });
 every("12m", () => {}, { runFirstTimeImmediately: true });
+every('', async () => {})
 
 // @ts-expect-error
 cron(12, () => {});
@@ -72,6 +74,7 @@ cron("12m", () => {}, { times: 3 });
 // @ts-expect-error
 cron("12m", () => {}, { runFirstTimeImmediately: 1 });
 cron("12m", () => {}, { runFirstTimeImmediately: true });
+cron('', async () => {});
 
 // @ts-expect-error
 env(12);