@bigbinary/neeto-commons-frontend 2.0.62 → 2.0.64

package/utils.d.ts

@@ -1,3 +1,4 @@
+import { Subscription } from "@rails/actioncable";
 import dayjs from "dayjs";
 import React from "react";
 export function resetAuthTokens(): void;
@@ -300,4 +301,30 @@ export function hasAnyPermission(...permissions: string[]): boolean;
  * hasAllPermissions("user.view_settings", "user.edit_settings");
  * @endexample
 */
-export function hasAllPermissions(...permissions: string[]): boolean;
+export function hasAllPermissions(...permissions: string[]): boolean;
+type ChannelNameWithParams = {
+  channel: string;
+  [key: string]: any;
+};
+/**
+ *
+ * Curried: false
+ *
+ * This function will create subscription were consumer is subscribed to rails
+ *
+ * action cable channel.
+ *
+ * Usage:
+ *
+ * @example 
+ *
+ * const subscription = createSubscription(
+ *   {
+ *     channel: "testChannel",
+ *     deployment_id: "deploymentId",
+ *   },
+ *   value => handleValue(value)
+ * );
+ * @endexample
+*/
+export function createSubscription(channelName: string | ChannelNameWithParams, callback: (value: string) => void): Subscription;