feat: add docstrings to postMessage methods

Author: artus9033

packages/react-native-brownfield/android/src/main/java/com/callstack/reactnativebrownfield/ReactNativeBrownfield.kt

@@ -121,14 +121,32 @@ class ReactNativeBrownfield private constructor(val reactHost: ReactHost) {
         }
     }
 
+    /**
+     * Send a serialized JSON message to the React Native JS application. This resembles the web `window.postMessage` API.
+     * @note This method is available only on the New Architecture - on Old Architecture, it will be a no-op.
+     * @param message - The serialized JSON message to send to the React Native JS application.
+     * @example
+     * val json = JSONObject().put("text", text).toString()
+     * ReactNativeBrownfield.shared.postMessage(json)
+     */
     fun postMessage(message: String) {
         ReactNativeBrownfieldModule.emitMessageFromNative(message)
     }
 
+    /**
+     * Register a listener for messages sent from the React Native JS application.
+     * @note This method is available only on the New Architecture - on Old Architecture, it will be a no-op.
+     * @param listener - The listener to register.
+     */
     fun addMessageListener(listener: OnMessageListener) {
         messageListeners.add(listener)
     }
 
+    /**
+     * Remove a previously registered message listener.
+     * @note This method is available only on the New Architecture - on Old Architecture, it will be a no-op.
+     * @param listener - The listener to remove.
+     */
     fun removeMessageListener(listener: OnMessageListener) {
         messageListeners.remove(listener)
     }

packages/react-native-brownfield/ios/ReactNativeBrownfield.swift

@@ -136,10 +136,13 @@ internal import Expo
   }
 
   /**
-   * Send a JSON-serialized message to the React Native JS layer.
+   * Send a serialized JSON message to the React Native JS application.
    * The message is delivered as a `brownfieldMessage` DeviceEventEmitter event.
    *
-   * @param message A JSON string to send to JavaScript.
+   * @param message - The serialized JSON message to send to the React Native JS application.
+   * @example
+   * let json = "{\"text\":\"\(text)\"}"
+   * ReactNativeBrownfield.shared.postMessage(json)
    */
   @objc public func postMessage(_ message: String) {
     let userInfo: [String: Any] = ["message": message]

packages/react-native-brownfield/src/index.ts

@@ -7,6 +7,13 @@ export interface MessageEvent {
 }
 
 const ReactNativeBrownfield = {
+  /**
+   * Pop to the native screen.
+   * @param animated - Whether to animate the transition (iOS only).
+   * @platform android, ios
+   * @example
+   * ReactNativeBrownfield.popToNative(true);
+   */
   popToNative: (animated?: boolean): void => {
     if (Platform.OS === 'ios') {
       ReactNativeBrownfieldModule.popToNative(!!animated);
@@ -17,6 +24,14 @@ const ReactNativeBrownfield = {
     }
   },
 
+  /**
+   * Enable or disable the iOS native back gesture and Android hardware back button.
+   * @note This method is available both on the New Architecture and the Old Architecture.
+   * @param enabled - Whether to enable native back gesture and button.
+   * @platform android, ios
+   * @example
+   * ReactNativeBrownfield.setNativeBackGestureAndButtonEnabled(true);
+   */
   setNativeBackGestureAndButtonEnabled: (enabled: boolean): void => {
     if (Platform.OS === 'ios') {
       ReactNativeBrownfieldModule.setPopGestureRecognizerEnabled(enabled);
@@ -27,11 +42,34 @@ const ReactNativeBrownfield = {
     }
   },
 
+  /**
+   * Send a JSON-serializable message to the native host application. This resembles the web `window.postMessage` API.
+   * @note This method is available both on the New Architecture and the Old Architecture.
+   * @note This method requires the `data` to be JSON-serializable. The method does not catch any serialization errors thrown
+   * by the `JSON.stringify` function, this is the responsibility of the caller.
+   * @param data - The data to send to the native host application.
+   * @platform android, ios
+   * @example
+   * ReactNativeBrownfield.postMessage({ text: 'Hello from React Native!', id: 2 });
+   */
   postMessage: (data: unknown): void => {
     const serialized = JSON.stringify(data);
     ReactNativeBrownfieldModule.postMessage(serialized);
   },
 
+  /**
+   * Subscribe to messages sent from the native host application. Returns a subscription object with a `remove()` method for cleanup.
+   * @param callback - The callback to invoke when a message is received from the native host application.
+   * @returns A subscription object with a `remove` method for cleanup.
+   * @platform android, ios
+   * @example
+   * const subscription = ReactNativeBrownfield.onMessage((event: MessageEvent) => {
+   *   console.log('Received from native:', event.data);
+   * });
+   *
+   * // Later, to unsubscribe:
+   * subscription.remove();
+   */
   onMessage: (
     callback: (event: MessageEvent) => void
   ): { remove: () => void } => {