waku-react/src/useLightPush.ts

import React from "react";
import type {
  IEncoder,
  ILightPush,
  IMessage,
  ProtocolOptions,
  SendResult,
  Waku,
} from "@waku/interfaces";

type AbstractLightPushNode = Waku & {
  lightPush: ILightPush;
};

type UseLightPushParams = {
  encoder: undefined | IEncoder;
  node: undefined | AbstractLightPushNode;
};

type PushFn = (
  message: IMessage,
  opts?: ProtocolOptions,
) => Promise<SendResult>;

type UseLightPushResult = {
  push?: undefined | PushFn;
};

/**
 * Returns light push methods bound to node and encoder
 * @param {Object} params.node - node that implements ILightPush, hook does nothing if empty
 * @param {Object} params.encoder - encoder for processing messages, hook does nothing if empty
 * @returns {Object} methods of ILightPush such as push
 */
export const useLightPush = (
  params: UseLightPushParams,
): UseLightPushResult => {
  const { node, encoder } = params;

  const push = React.useCallback<PushFn>(
    (message, opts = undefined) => {
      return node!.lightPush.send(encoder as IEncoder, message, opts);
    },
    [node, encoder],
  );

  if (!node && !encoder) {
    return {};
  }

  return {
    push,
  };
};