docs(shared): add example for Symbols.serialize

altmp · Aug 24, 2024 · c4ecabb · c4ecabb
1 parent 2ca2cb9
commit c4ecabb
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/types/shared/index.d.ts b/types/shared/index.d.ts
@@ -3449,6 +3449,25 @@ declare module "@altv/shared" {
     }
 
     export namespace Symbols {
+        /**
+         * @example
+         * ```
+         * const myObj = {
+         *     a: 1,
+         *     b: 2,
+         *     [alt.Symbols.serialize]: () => {
+         *         return {
+         *             c: myObj.a + myObj.b
+         *         };
+         *     }
+         * };
+         *
+         * alt.Events.on("testabc", (obj) => {
+         *     alt.log(obj); // { c: 3 }
+         * });
+         * alt.Events.emit("testabc", myObj);
+         * ```
+         */
         export const serialize: unique symbol;
     }