sigit/sigit.io
6
2
Fork 0
Code Issues 41 Pull Requests 2 Actions Packages Projects 1 Releases Wiki Activity

chore: update tsdoc for function defination in relay controller
All checks were successful
Open PR on Staging / audit_and_check (pull_request) Successful in 33s
Details

Browse Source
This commit is contained in:
daniyal 2024-08-20 13:55:31 +05:00
parent c274879adc
commit a788309126
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/controllers/RelayController.ts
View File

@ -78,9 +78,9 @@ export class RelayController {
* Asynchronously retrieves multiple event from a set of relays based on a provided filter. * 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. * If no relays are specified, it defaults to using connected relays.
* *
* @param {Filter} filter - The filter criteria to find the event. * @param filter - The filter criteria to find the event.
* @param {string[]} [relays] - An optional array of relay URLs to search for the event. * @param relays - An optional array of relay URLs to search for the event.
* @returns {Promise<Event | null>} - Returns a promise that resolves to the found event or null if not found. * @returns Returns a promise that resolves with an array of events.
*/ */
fetchEvents = async ( fetchEvents = async (
filter: Filter, filter: Filter,
@ -170,9 +170,9 @@ export class RelayController {
* Asynchronously retrieves an event from a set of relays based on a provided filter. * 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. * If no relays are specified, it defaults to using connected relays.
* *
* @param {Filter} filter - The filter criteria to find the event. * @param filter - The filter criteria to find the event.
* @param {string[]} [relays] - An optional array of relay URLs to search for the event. * @param relays - An optional array of relay URLs to search for the event.
* @returns {Promise<Event | null>} - Returns a promise that resolves to the found event or null if not found. * @returns Returns a promise that resolves to the found event or null if not found.
*/ */
fetchEvent = async ( fetchEvent = async (
filter: Filter, filter: Filter,