From a7883091266849eca17a959d21289469374ce147 Mon Sep 17 00:00:00 2001 From: daniyal Date: Tue, 20 Aug 2024 13:55:31 +0500 Subject: [PATCH] chore: update tsdoc for function defination in relay controller --- src/controllers/RelayController.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/controllers/RelayController.ts b/src/controllers/RelayController.ts index 9bb969c..12f24c2 100644 --- a/src/controllers/RelayController.ts +++ b/src/controllers/RelayController.ts @@ -78,9 +78,9 @@ export class RelayController { * Asynchronously retrieves multiple event from a set of relays based on a provided filter. * If no relays are specified, it defaults to using connected relays. * - * @param {Filter} filter - The filter criteria to find the event. - * @param {string[]} [relays] - An optional array of relay URLs to search for the event. - * @returns {Promise} - Returns a promise that resolves to the found event or null if not found. + * @param filter - The filter criteria to find the event. + * @param relays - An optional array of relay URLs to search for the event. + * @returns Returns a promise that resolves with an array of events. */ fetchEvents = async ( filter: Filter, @@ -170,9 +170,9 @@ export class RelayController { * Asynchronously retrieves an event from a set of relays based on a provided filter. * If no relays are specified, it defaults to using connected relays. * - * @param {Filter} filter - The filter criteria to find the event. - * @param {string[]} [relays] - An optional array of relay URLs to search for the event. - * @returns {Promise} - Returns a promise that resolves to the found event or null if not found. + * @param filter - The filter criteria to find the event. + * @param relays - An optional array of relay URLs to search for the event. + * @returns Returns a promise that resolves to the found event or null if not found. */ fetchEvent = async ( filter: Filter,