buzzcasting-storage 1.0.13 → 2.0.2

package/README.md

@@ -22,32 +22,32 @@ Example call:
 
 ```js
 import BuzzcastingStorageManager, {
+  IMessages,
   IQuery,
   IStorageManager,
-  IMessages,
-} from "buzzcasting-storage";
+} from 'buzzcasting-storage'
 
 const options: IStorageManager = {
-  app: "my-subdomain",
-  version: "v4",
-  token: "meta",
-  bearer: "bearer_token",
-  storage: "dexie",
-  moderation: "none",
+  app: 'my-subdomain',
+  version: 'v4',
+  token: 'meta',
+  bearer: 'bearer_token',
+  storage: 'dexie',
+  moderation: 'none',
   beforeTime: null,
   delay: 0,
   period: 0,
-};
+}
 
-let storageManager = new BuzzcastingStorageManager(options);
+const storageManager = new BuzzcastingStorageManager(options)
 
 const query: IQuery = {
-  type: "messages",
-  dashboard: "dashboard_id",
-  widget: "widget_id",
-};
+  type: 'messages',
+  dashboard: 'dashboard_id',
+  widget: 'widget_id',
+}
 
-const data: IMessages = storageManager.getMessages(query);
+const data: IMessages = storageManager.getMessages(query)
 ```
 
 This will initiate a call to the buzzcasting backoffice to retrieve results
@@ -55,7 +55,6 @@ This will initiate a call to the buzzcasting backoffice to retrieve results
 The Storage Manager will carry out the API call for the subscriber, and send out a BroadcastChannel on `app` to inform the subcriber that it can retrieve new data. The broadcast channel facilitates its incorporation in for example a Web Worker.
 
 ```js
-
 const broadcastChannel = new BroadcastChannel('my-subdomain')
 
 broadcastChannel.onmessage = (messageEvent: MessageEvent) => {
@@ -69,10 +68,9 @@ actions = (messageEvent: MessageEvent) => {
       this.widgetUpdated.emit(messageEvent.data.data)
       break
     default:
-      //console.log('[storage]', messageEvent.data)
+      // console.log('[storage]', messageEvent.data)
   }
 }
-
 ```
 
 ### Git Clone

package/dist/buzzcasting-storage.d.ts

@@ -3,7 +3,7 @@ declare class BuzzcastingStorageManager {
     private api;
     private bc;
     private options;
-    constructor(options: IStorageManager);
+    constructor(options: IStorageOptions);
     update: () => Promise<void>;
     hide: (query: IQuery) => void;
     private actions;
@@ -52,24 +52,24 @@ export declare interface IQuery {
     widget?: string;
     compare?: string;
     period?: number;
-    type?: "cloud" | "messages" | "indicators" | "proxy";
+    type?: 'cloud' | 'messages' | 'indicators' | 'proxy';
     order?: string;
     media?: number;
     dynamics?: number;
     geo?: number;
     delay?: string;
     approved?: string;
-    moderation?: "realtime" | "delayed" | "approved";
+    moderation?: 'realtime' | 'delayed' | 'approved';
     hrm?: string;
     before?: number;
     since?: number;
 }
 
-export declare interface IStorageManager {
+export declare interface IStorageOptions {
     app: string;
     version: string;
     storage: string;
-    slide?: string;
+    slide: string;
     presentation?: string;
     token?: string;
     bearer?: string;