types docs

client/src/types/client.ts

@@ -2,15 +2,31 @@
 
 import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
 
+/**
+ * Union of all available client event names
+ * These only include custom events
+ */
 export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
 
+/**
+ * Array of arguments for an event, name of which you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
     Parameters<RageFW_ICustomClientEvent[K]>
 
+/**
+ * Callback (function) for an event, name of which you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientEventCallback<K extends RageFW_ClientEvent> = (
     args: RageFW_ClientEventArguments<K>,
 ) => RageFW_ClientEventReturn<K>
 
+/**
+ * Return type for an event, name of which you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
     K extends keyof RageFW_ICustomClientEvent
         ? ReturnType<RageFW_ICustomClientEvent[K]>

client/src/types/server.ts

@@ -2,14 +2,26 @@
 
 import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
 
+/**
+ * Union of all available server event names callable from client
+ * These only include custom events
+ */
 export type RageFW_ClientServerEvent = keyof RageFW_ICustomServerEvent
 
+/**
+ * Array of arguments for an event, name of which you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientServerEventArguments<
     K extends RageFW_ClientServerEvent,
 > = K extends keyof RageFW_ICustomServerEvent
     ? Parameters<RageFW_ICustomServerEvent[K]>
     : never
 
+/**
+ * Return type for an event, name of which you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientServerEventReturn<K extends RageFW_ClientServerEvent> =
     K extends keyof RageFW_ICustomServerEvent
         ? ReturnType<RageFW_ICustomServerEvent[K]>