API alignment: handler is always in options

README.md

@@ -145,7 +145,7 @@ The file `EXAMPLE_CONFIG.json5` references the `zenoh-plugin-remote-api\EXAMPLE_
    yarn build
    ```
 
-   The result are placed into the `zenoh-ts/dist` directory.
+   The result is placed into the `zenoh-ts/dist` directory.
 
    This library is currently compatible with browsers, but not with NodeJS due to websocket library limitations.
 

zenoh-ts/examples/chat/src/chat_session.ts

@@ -121,18 +121,20 @@ export class ChatSession {
 		log(`[Session] Declare publisher on ${keyexpr}`);
 
 		this.message_subscriber = await this.session.declare_subscriber(KEYEXPR_CHAT_USER.join("*"),
-			(sample: Sample) => {
-				let message = deserialize_string(sample.payload().to_bytes());
-				log(`[Subscriber] Received message: ${message} from ${sample.keyexpr().toString()}`);
-				let user = ChatUser.fromKeyexpr(sample.keyexpr());
-				if (user) {
-					const timestamp = new Date().toISOString();
-					this.messages.push({ t: timestamp, u: user.username, m: message });
-					if (this.messageCallback) {
-						this.messageCallback(user, message);
+			{ 
+				handler: (sample: Sample) => {
+					let message = deserialize_string(sample.payload().to_bytes());
+					log(`[Subscriber] Received message: ${message} from ${sample.keyexpr().toString()}`);
+					let user = ChatUser.fromKeyexpr(sample.keyexpr());
+					if (user) {
+						const timestamp = new Date().toISOString();
+						this.messages.push({ t: timestamp, u: user.username, m: message });
+						if (this.messageCallback) {
+							this.messageCallback(user, message);
+						}
 					}
+					return Promise.resolve();
 				}
-				return Promise.resolve();
 			}
 		);
 		log(`[Session] Declare Subscriber on ${KEYEXPR_CHAT_USER.join("*").toString()}`);
@@ -142,7 +144,7 @@ export class ChatSession {
 
 		// Subscribe to changes of users presence
 		this.liveliness_subscriber = this.session.liveliness().declare_subscriber(KEYEXPR_CHAT_USER.join("*"), {
-			callback: (sample: Sample) => {
+			handler: (sample: Sample) => {
 				let keyexpr = sample.keyexpr();
 				let user = ChatUser.fromKeyexpr(keyexpr);
 				if (!user) {

zenoh-ts/examples/deno/src/z_ping.ts

@@ -18,7 +18,7 @@ import { Encoding, CongestionControl, Config, Session } from "@eclipse-zenoh/zen
 export async function main() {
   const session = await Session.open(new Config("ws/127.0.0.1:10000"));
 
-  const sub = session.declare_subscriber("test/pong", new FifoChannel(256) );
+  const sub = session.declare_subscriber("test/pong", { handler: new FifoChannel(256) } );
   const pub = session.declare_publisher(
     "test/ping",
     {

zenoh-ts/examples/deno/src/z_pong.ts

@@ -29,7 +29,7 @@ export async function main() {
     pub.put(sample.payload());
   };
 
-  session.declare_subscriber("test/pong", subscriber_callback);
+  session.declare_subscriber("test/pong", { handler: subscriber_callback } );
 
   let count = 0;
   while (true) {

zenoh-ts/examples/deno/src/z_sub.ts

@@ -24,7 +24,7 @@ export async function main() {
   const session = await Session.open(new Config("ws/127.0.0.1:10000"));
   const key_expr = new KeyExpr(args.key);
 
-  const poll_subscriber: Subscriber = session.declare_subscriber(key_expr, new RingChannel(10));
+  const poll_subscriber: Subscriber = session.declare_subscriber(key_expr, { handler: new RingChannel(10) });
 
   let sample = await poll_subscriber.receive();
 

zenoh-ts/examples/deno/src/z_sub_thr.ts

@@ -63,7 +63,7 @@ export async function main() {
   console.warn("Declare subscriber");
   session.declare_subscriber(
     "test/thr",
-    subscriber_callback
+    { handler: subscriber_callback }
   );
 
   let count = 0;

zenoh-ts/src/liveliness.ts

@@ -25,12 +25,12 @@ function executeAsync(func: any) {
 }
 
 interface LivelinessSubscriberOptions {
-  callback?: (sample: Sample) => Promise<void>,
+  handler?: (sample: Sample) => Promise<void>, // TODO: add | Handler,
   history: boolean,
 }
 
 interface LivelinessGetOptions {
-  callback?: (reply: Reply) => Promise<void>,
+  handler?: (reply: Reply) => Promise<void>, // TODO: add | Handler,
   timeout?: TimeDuration,
 }
 
@@ -61,8 +61,8 @@ export class Liveliness {
     let remote_subscriber;
     let callback_subscriber = false;
 
-    if (options?.callback !== undefined) {
-      let callback = options?.callback;
+    if (options?.handler !== undefined) {
+      let callback = options?.handler;
       callback_subscriber = true;
       const callback_conversion = async function (sample_ws: SampleWS,): Promise<void> {
         let sample: Sample = Sample_from_SampleWS(sample_ws);
@@ -102,7 +102,7 @@ export class Liveliness {
 
     let receiver = Receiver.new(chan);
 
-    let callback = options?.callback;
+    let callback = options?.handler;
     if (callback !== undefined) {
       executeAsync(async () => {
         for await (const message of chan) {

zenoh-ts/src/session.ts

@@ -150,6 +150,14 @@ export interface PublisherOptions {
   reliability?: Reliability,
 }
 
+/**
+ * Options for a Subscriber
+ * @prop handler - Callback function for this subscriber
+ */
+export interface SubscriberOptions {
+  handler?: ((sample: Sample) => Promise<void>) | Handler,
+}
+
 // ███████ ███████ ███████ ███████ ██  ██████  ███    ██
 // ██      ██      ██      ██      ██ ██    ██ ████   ██
 // ███████ █████   ███████ ███████ ██ ██    ██ ██ ██  ██
@@ -422,20 +430,23 @@ export class Session {
    *  If a Subscriber is created with a callback, it cannot be simultaneously polled for new values
    * 
    * @param {IntoKeyExpr} key_expr - string of key_expression
-   * @param {((sample: Sample) => Promise<void>) | Handler} handler - Either a HandlerChannel or a Callback Function to be called for all samples
+   * @param {SubscriberOptions} subscriber_opts - Options for the subscriber, including a handler
    *
    * @returns Subscriber
    */
   // Handler size : This is to match the API_DATA_RECEPTION_CHANNEL_SIZE of zenoh internally
   declare_subscriber(
     key_expr: IntoKeyExpr,
-    handler?: ((sample: Sample) => Promise<void>) | Handler
+    subscriber_opts?: SubscriberOptions
   ): Subscriber {
     let _key_expr = new KeyExpr(key_expr);
     let remote_subscriber: RemoteSubscriber;
 
     let callback_subscriber = false;
-    if (handler === undefined) {
+    let handler;
+    if (subscriber_opts?.handler !== undefined) {
+      handler = subscriber_opts?.handler;
+    } else {
       handler = new FifoChannel(256);
     }
     let [callback, handler_type] = check_handler_or_callback<Sample>(handler);