react-nitro-networking 0.0.0-stage → 0.0.1-alpha.7

package/src/specs/WebSocket.nitro.ts

@@ -0,0 +1,62 @@
+import { iOS, type HybridObject } from 'nitro-core'
+import type { ListenerSubscription } from '../ListenerSubscription'
+
+export * from '#nitro/WebSocket'
+
+/**
+ * A text and binary message connection.
+ * Connecting starts automatically. Call {@linkcode WebSocket.close} when finished.
+ * A closed socket cannot be reopened; create another socket to reconnect.
+ */
+@iOS({
+  language: 'swift',
+  implementation: {
+    className: 'HybridWebSocket',
+  },
+})
+export declare class WebSocket extends HybridObject {
+  /**
+   * Starts connecting to an absolute `ws://` or `wss://` URL.
+   * Throws for invalid URLs. Connection failures are delivered to the socket's error listeners.
+   */
+  public constructor(url: string)
+
+  /**
+   * Sends one text or binary message, waiting for the connection if it is still opening.
+   * Resolves when the message is sent, not when the peer acknowledges it.
+   * Await each send when message order matters. Rejects if sending fails or the socket is closed.
+   * Binary data is copied at the call boundary so subsequent mutations do not affect the message.
+   */
+  send(data: string | ArrayBuffer): Promise<void>
+
+  /**
+   * Closes the socket, including while connecting, and releases its listeners.
+   * Pending operations may fail. Safe to call more than once.
+   * The closed event reports local shutdown, not acknowledgement from the peer.
+   */
+  close(): void
+
+  /**
+   * Called once after the handshake succeeds. Also notifies listeners added while already open.
+   * Not called if connecting fails or the socket has already closed.
+   */
+  addOnOpenedListener(listener: () => void): ListenerSubscription
+
+  /**
+   * Receives complete text or binary messages in arrival order.
+   * Until the first listener is added, up to 64 messages / 1 MiB are buffered; exceeding either
+   * limit closes the socket with an error. After that, messages without listeners are discarded.
+   * Closing discards buffered messages. Register before sending if a response is expected.
+   */
+  addOnMessageReceivedListener(listener: (data: string | ArrayBuffer) => void): ListenerSubscription
+
+  /** Called once on local close, peer close, or failure. Also notifies listeners added after closing. */
+  addOnClosedListener(listener: () => void): ListenerSubscription
+
+  /**
+   * Called on a terminal connection or receive failure, before closed listeners.
+   * Late listeners receive the terminal error. An explicit close does not emit an error.
+   * Individual send failures also reject their send Promise.
+   */
+  addOnErrorListener(listener: (error: Error) => void): ListenerSubscription
+}