browser/src/core/browser.ts

@@ -7,43 +7,21 @@ import {
     RageFW_ServerEvent,
 } from '../types'
 
-/** Browser-side interactions */
 export class Browser extends Helper {
     constructor() {
         super()
     }
 
-    /**
-     * Setter. Enables console debug logs for events
-     */
     set debugLogs(debug: boolean) {
         this.debugLogs_ = debug
     }
 
-    /**
-     * Setter. Provides an ability to specify custom logger function to get special formatting. Using this enables ``debugLogs``
-     */
     set customLogger(
         fn: (method: string, eventName: string, ...args: unknown[]) => unknown,
     ) {
         this.customLogger_ = fn
     }
 
-    /**
-     * Registers a browser event with an associated callback
-     *
-     * @param eventName - The name of the event to register
-     * @param callback - The callback function to be executed when the event is triggered
-     * @returns {Browser} The current browser instance, enabling method chaining
-     *
-     * @example
-     * // Registering an event
-     * fw.event.register("showNotification", (message, color) => {
-     *     // do something
-     * })
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public register<EventName extends T.RageFW_BrowserEvent>(
         eventName: EventName,
         callback: T.RageFW_BrowserCallback<EventName>,
@@ -59,18 +37,6 @@ export class Browser extends Helper {
         return this
     }
 
-    /**
-     * Unregisters a browser event, removing the associated callback
-     *
-     * @param eventName - The name of the event to unregister
-     * @returns {Browser} The current browser instance, enabling method chaining
-     *
-     * @example
-     * // Unregistering an event
-     * fw.event.unregister("showNotification")
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public unregister<EventName extends T.RageFW_BrowserEvent>(
         eventName: EventName,
     ): Browser {
@@ -79,25 +45,6 @@ export class Browser extends Helper {
         return this
     }
 
-    /**
-     * Triggers a browser event from the browser with arguments from shared types
-     *
-     * Formerly known as ``call`` or ``emit``
-     *
-     * @param eventName - The name of the browser event to trigger
-     * @param [args] - Arguments for the browser event, if present
-     * @returns {Promise} resolving to the browser's response for the event
-     *
-     * @example
-     * // Triggering a browser event without arguments
-     * fw.event.trigger("browserEventName")
-     *
-     * @example
-     * // Triggering a browser event with arguments
-     * fw.event.trigger("browserEventName", ["message to me"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async trigger<EventName extends T.RageFW_BrowserEvent>(
         eventName: EventName,
         ...args: T._BrowserEventHasArgs<EventName> extends true
@@ -113,25 +60,6 @@ export class Browser extends Helper {
         >(eventName, args)
     }
 
-    /**
-     * Triggers a server event from the browser with arguments from shared types
-     *
-     * Formerly known as ``callServer`` or ``emitServer``
-     *
-     * @param eventName - The name of the server event to trigger
-     * @param [args] - Arguments for the server event, if present
-     * @returns {Promise} resolving to the server's response for the event
-     *
-     * @example
-     * // Triggering a server event without arguments
-     * fw.event.triggerServer("serverEventName")
-     *
-     * @example
-     * // Triggering a server event with arguments
-     * fw.event.triggerServer("serverEventName", ["message to server"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async triggerServer<EventName extends T.RageFW_ServerEvent>(
         eventName: EventName,
         ...args: T._ServerEventHasArgs<EventName> extends true
@@ -147,25 +75,6 @@ export class Browser extends Helper {
         >(eventName, args)
     }
 
-    /**
-     * Triggers a client event from the browser with arguments from shared types
-     *
-     * Formerly known as ``callClient`` or ``emitClient``
-     *
-     * @param eventName - The name of the client event to trigger
-     * @param [args] - Arguments for the client event, if present
-     * @returns {Promise} resolving to the client's response for the event
-     *
-     * @example
-     * // Triggering a client event without arguments
-     * fw.event.triggerClient("clientEventName")
-     *
-     * @example
-     * // Triggering a client event with arguments
-     * fw.event.triggerClient("clientEventName", ["message to client"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async triggerClient<EventName extends T.RageFW_ClientEvent>(
         eventName: EventName,
         ...args: T._ClientEventHasArgs<EventName> extends true

browser/src/index.ts

@@ -1,14 +1,7 @@
 import { Browser, rpc } from './core'
 
-/**
- * Package used on a browser-side of your Rage:MP Server
- *
- * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
- */
 export const fw = {
-    /** Browser-side interactions */
     event: new Browser(),
-    /** ``rage-fw-rpc`` instance used under the hood. It is highly recommended to use this one if you need it instead of creating a new instance */
     rpc,
 }
 ;(async () => {

client/src/core/client.ts

@@ -2,44 +2,7 @@ import { rpc } from './rpc'
 import { Middleware } from './middleware'
 import type * as T from '../types'
 
-/** Client-side interactions */
 export class Client {
-    /**
-     * Registers a client event with an associated callback
-     *
-     * @param eventName - The name of the event to register
-     * @param callback - The callback function to be executed when the event is triggered
-     * @param [options] - Optional settings for callback execution
-     * @param [options.middlewares] - Middleware functions to be checked before the callback executes
-     * @returns {Client} The current client instance, enabling method chaining
-     *
-     * @example
-     * // Registering an event
-     * fw.event.register("playerDeath", (player, reason, killer) => {
-     *     fw.system.log.info(player, reason, killer)
-     * })
-     *
-     * @example
-     * // Registering an event with middlewares
-     * fw.event.register("playerDeath", (player, reason, killer) => {
-     *     fw.system.log.info(player, reason, killer)
-     * }, {
-     *     middlewares: [ignoreSuicide] // <- your middlewares here
-     * })
-     *
-     * // or
-     *
-     * fw.event.register("playerDeath", (player, reason, killer) => {
-     *     fw.system.log.info(player, reason, killer)
-     * }, {
-     *     middlewares: {
-     *         executables: [ignoreSuicide], // <- your middlewares here
-     *         onError: (msg) => fw.system.log.info(`${player.socialClub} has commited suicide`)
-     *     }
-     * })
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public register<EventName extends T.RageFW_ClientEvent>(
         eventName: EventName,
         callback: T.RageFW_ClientCallback<EventName>,
@@ -60,18 +23,6 @@ export class Client {
         return this
     }
 
-    /**
-     * Unregisters a client event, removing the associated callback
-     *
-     * @param eventName - The name of the event to unregister
-     * @returns {Client} The current client instance, enabling method chaining
-     *
-     * @example
-     * // Unregistering an event
-     * fw.event.unregister("playerDeath")
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public unregister<EventName extends T.RageFW_ClientEvent>(
         eventName: EventName,
     ): Client {

client/src/core/logger.ts

@@ -1,40 +1,19 @@
-/**
- * Used to log to a client in-game console
- */
 export class Logger {
-    /**
+    public error(...message: unknown[]) {
-     * Informational logs. Colored in white
+        mp.console.logError(
-     *
+            `[${new Date().toLocaleTimeString()}] [ERROR] ${message.join(' ')}`,
-     * @example
-     * fw.system.log.info('some information to be logged')
-     */
-    public info(...message: unknown[]) {
-        mp.console.logInfo(
-            `[${new Date().toLocaleTimeString()}] [INFO] ${message.join(' ')}`,
         )
     }
 
-    /**
-     * Warning logs. Colored in yellow
-     *
-     * @example
-     * fw.system.log.warn('warning message')
-     */
     public warn(...message: unknown[]) {
         mp.console.logWarning(
             `[${new Date().toLocaleTimeString()}] [WARN] ${message.join(' ')}`,
         )
     }
 
-    /**
+    public info(...message: unknown[]) {
-     * Error logs. Colored in red
+        mp.console.logInfo(
-     *
+            `[${new Date().toLocaleTimeString()}] [INFO] ${message.join(' ')}`,
-     * @example
-     * fw.system.log.info('some error information')
-     */
-    public error(...message: unknown[]) {
-        mp.console.logError(
-            `[${new Date().toLocaleTimeString()}] [ERROR] ${message.join(' ')}`,
         )
     }
 }

client/src/core/player.ts

@@ -1,37 +1,14 @@
 import { rpc } from './rpc'
 import type * as T from '../types'
 
-/** Handles event manipulations that require player to be present in context */
 export class Player {
     private _browser: BrowserMp | undefined = undefined
 
-    /**
-     * Setter. Also shares browser with ``rage-fw-rpc``
-     */
     set browser(browser: BrowserMp) {
         this._browser = browser
         rpc.browser = browser
     }
 
-    /**
-     * Triggers a client event from the client with arguments from shared types
-     *
-     * Formerly known as ``call`` or ``emit``
-     *
-     * @param eventName - The name of the client event to trigger
-     * @param [args] - Arguments for the client event, if present
-     * @returns {Promise} resolving to the client's response for the event
-     *
-     * @example
-     * // Triggering a client event without arguments
-     * fw.player.trigger("clientEventName")
-     *
-     * @example
-     * // Triggering a client event with arguments
-     * fw.player.trigger("clientEventName", ["message to me"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async trigger<EventName extends keyof T.RageFW_ICustomClientEvent>(
         eventName: EventName,
         ...args: T._ClientEventHasArgs<EventName> extends true
@@ -45,25 +22,6 @@ export class Player {
         >(eventName, args)
     }
 
-    /**
-     * Triggers a server event from the client with arguments from shared types
-     *
-     * Formerly known as ``callServer`` or ``emitServer``
-     *
-     * @param eventName - The name of the server event to trigger
-     * @param [args] - Arguments for the server event, if present
-     * @returns {Promise} resolving to the server's response for the event
-     *
-     * @example
-     * // Triggering a server event without arguments
-     * fw.player.triggerServer("serverEventName")
-     *
-     * @example
-     * // Triggering a server event with arguments
-     * fw.player.triggerServer("serverEventName", ["message to server"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async triggerServer<EventName extends T.RageFW_ServerEvent>(
         eventName: EventName,
         ...args: T._ServerEventHasArgs<EventName> extends true
@@ -77,25 +35,6 @@ export class Player {
         >(eventName, args)
     }
 
-    /**
-     * Triggers a browser event from the client with arguments from shared types
-     *
-     * Formerly known as ``callBrowser`` or ``emitBrowser``
-     *
-     * @param eventName - The name of the browser event to trigger
-     * @param [args] - Arguments for the browser event, if present
-     * @returns {Promise} resolving to the browser's response for the event
-     *
-     * @example
-     * // Triggering a browser event without arguments
-     * fw.player.triggerBrowser("browserEventName")
-     *
-     * @example
-     * // Triggering a browser event with arguments
-     * fw.player.triggerBrowser("browserEventName", ["message to browser"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
         eventName: EventName,
         ...args: T._BrowserEventHasArgs<EventName> extends true

client/src/index.ts

@@ -2,21 +2,11 @@ import { Client, Logger, Player, rpc } from './core'
 
 export type { RageFW_MiddlewareFunction } from './types'
 
-/**
- * Package used on a client-side of your Rage:MP Server
- *
- * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
- */
 export const fw = {
-    /** Client-side interactions */
     event: new Client(),
-    /** Handles event manipulations that require player to be present in context */
     player: new Player(),
-    /** Handles functions used to interact with the client environment */
     system: {
-        /** Used to log in a client in-game console */
         log: new Logger(),
     },
-    /** ``rage-fw-rpc`` instance used under the hood. It is highly recommended to use this one if you need it instead of creating a new instance */
     rpc,
 }

server/src/core/logger.ts

@@ -2,7 +2,6 @@ import winston, { format } from 'winston'
 
 const { timestamp, printf, colorize } = format
 
-/** Used to log in a server console */
 export class Logger {
     private format = printf(({ message, level, timestamp }) => {
         return `[${new Date(timestamp).toLocaleTimeString()}] [${level}]: ${message}`
@@ -24,32 +23,14 @@ export class Logger {
         ),
     })
 
-    /**
-     * Informational logs. Colored in white
-     *
-     * @example
-     * fw.system.log.info('some information to be logged')
-     */
     public info(...message: unknown[]) {
         this.systemLogger.info(message.join(' '))
     }
 
-    /**
-     * Warning logs. Colored in yellow
-     *
-     * @example
-     * fw.system.log.warn('warning message')
-     */
     public warn(...message: unknown[]) {
         this.systemLogger.warn(message.join(' '))
     }
 
-    /**
-     * Error logs. Colored in red
-     *
-     * @example
-     * fw.system.log.info('some error information')
-     */
     public error(...message: unknown[]) {
         this.systemLogger.error(message.join(' '))
     }

server/src/core/player.ts

@@ -1,28 +1,7 @@
 import { rpc } from './rpc'
 import type * as T from '../types'
 
-/** Handles event manipulations that require player to be present in context */
 export class Player {
-    /**
-     * Triggers a client event from the server with arguments from shared types
-     *
-     * Formerly known as ``callClient`` or ``emitClient``
-     *
-     * @param {PlayerMp} player - Player object as an event target
-     * @param eventName - The name of the client event to trigger
-     * @param [args] - Arguments for the client event, if present
-     * @returns {Promise} resolving to the client's response for the event
-     *
-     * @example
-     * // Triggering a client event without arguments
-     * fw.player.triggerClient("clientEventName")
-     *
-     * @example
-     * // Triggering a client event with arguments
-     * fw.player.triggerClient("clientEventName", ["message to client"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async triggerClient<EventName extends T.RageFW_ClientEvent>(
         player: PlayerMp,
         eventName: EventName,
@@ -33,26 +12,6 @@ export class Player {
         return await rpc.callClient(player, eventName, args)
     }
 
-    /**
-     * Triggers a browser event from the server with arguments from shared types
-     *
-     * Formerly known as ``callBrowser`` or ``emitBrowser``
-     *
-     * @param {PlayerMp} player - Player object as an event target
-     * @param eventName - The name of the browser event to trigger
-     * @param [args] - Arguments for the browser event, if present
-     * @returns {Promise} resolving to the browser's response for the event
-     *
-     * @example
-     * // Triggering a browser event without arguments
-     * fw.player.triggerBrowser("browserEventName")
-     *
-     * @example
-     * // Triggering a browser event with arguments
-     * fw.player.triggerBrowser("browserEventName", ["message to browser"])
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
         player: PlayerMp,
         eventName: EventName,

server/src/core/server.ts

@@ -2,44 +2,7 @@ import { rpc } from './rpc'
 import { Middleware } from './middleware'
 import type * as T from '../types'
 
-/** Server-side interactions */
 export class Server {
-    /**
-     * Registers a server event with an associated callback
-     *
-     * @param eventName - The name of the event to register
-     * @param callback - The callback function to be executed when the event is triggered
-     * @param [options] - Optional settings for callback execution
-     * @param [options.middlewares] - Middleware functions to be checked before the callback executes
-     * @returns {Server} The current server instance, enabling method chaining
-     *
-     * @example
-     * // Registering an event
-     * fw.event.register("playerJoin", (player) => {
-     *     fw.system.log.info(`${player.socialClub} has joined the game`)
-     * })
-     *
-     * @example
-     * // Registering an event with middlewares
-     * fw.event.register("playerJoin", (player) => {
-     *     fw.system.log.info(`${player.name} has joined the game`)
-     * }, {
-     *     middlewares: [ignoreBots] // <- your middlewares here
-     * })
-     *
-     * // or
-     *
-     * fw.event.register("playerJoin", (player) => {
-     *     fw.system.log.info(`${player.socialClub} has joined the game`)
-     * }, {
-     *     middlewares: {
-     *         executables: [ignoreBots], // <- your middlewares here
-     *         onError: (msg) => fw.system.log.info(`[BOT] ${player.socialClub} has joined the game`)
-     *     }
-     * })
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public register<EventName extends T.RageFW_ServerEvent>(
         eventName: EventName,
         callback: T.RageFW_ServerCallback<EventName>,
@@ -60,18 +23,6 @@ export class Server {
         return this
     }
 
-    /**
-     * Unregisters a server event, removing the associated callback
-     *
-     * @param eventName - The name of the event to unregister
-     * @returns {Server} The current server instance, enabling method chaining
-     *
-     * @example
-     * // Unregistering an event
-     * fw.event.unregister("playerJoin")
-     *
-     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
-     */
     public unregister<EventName extends T.RageFW_ServerEvent>(
         eventName: EventName,
     ): Server {

server/src/index.ts

@@ -2,22 +2,12 @@ import { Logger, Player, Server, rpc } from './core'
 
 export type { RageFW_MiddlewareFunction } from './types'
 
-/**
- * Package used on a server-side of your Rage:MP Server
- *
- * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
- */
 export const fw = {
-    /** Server-side interactions */
     event: new Server(),
-    /** Handles event manipulations that require player to be present in context */
     player: new Player(),
-    /** Handles functions used to interact with the client environment */
     system: {
-        /** Used to log in a server console */
         log: new Logger(),
     },
-    /** ``rage-fw-rpc`` instance used under the hood. It is highly recommended to use this one if you need it instead of creating a new instance */
     rpc,
 }