@cubejs-client/core 0.31.35 → 0.31.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +6 -2
  2. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -984,7 +984,7 @@ declare module '@cubejs-client/core' {
984
984
  * @order 4
985
985
  */
986
986
  export class Meta {
987
-
987
+
988
988
  constructor(metaResponse: MetaResponse);
989
989
 
990
990
  /**
@@ -1087,7 +1087,8 @@ declare module '@cubejs-client/core' {
1087
1087
  * Allows you to fetch data and receive updates over time. See [Real-Time Data Fetch](real-time-data-fetch)
1088
1088
  *
1089
1089
  * ```js
1090
- * cubejsApi.subscribe(
1090
+ * // Subscribe to a query's updates
1091
+ * const subscription = await cubejsApi.subscribe(
1091
1092
  * {
1092
1093
  * measures: ['Logs.count'],
1093
1094
  * timeDimensions: [
@@ -1105,6 +1106,9 @@ declare module '@cubejs-client/core' {
1105
1106
  * }
1106
1107
  * }
1107
1108
  * );
1109
+ *
1110
+ * // Unsubscribe from a query's updates
1111
+ * subscription.unsubscribe();
1108
1112
  * ```
1109
1113
  */
1110
1114
  subscribe<QueryType extends DeeplyReadonly<Query | Query[]>>(
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cubejs-client/core",
3
- "version": "0.31.35",
3
+ "version": "0.31.46",
4
4
  "engines": {},
5
5
  "repository": {
6
6
  "type": "git",
@@ -45,5 +45,5 @@
45
45
  "eslint-plugin-node": "^5.2.1",
46
46
  "jest": "^26.0.1"
47
47
  },
48
- "gitHead": "60f8f28f9174e3d7e5008e1d210e9f72605f5dcd"
48
+ "gitHead": "adb96e94ed8ade4f777c63fbe797a7f8f0bbf67e"
49
49
  }