@cubejs-client/core 0.31.0 → 0.31.8

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.31.8](https://github.com/cube-js/cube.js/compare/v0.31.7...v0.31.8) (2022-10-30)
+
+**Note:** Version bump only for package @cubejs-client/core
+
+
+
+
+
 # [0.31.0](https://github.com/cube-js/cube.js/compare/v0.30.75...v0.31.0) (2022-10-03)
 
 **Note:** Version bump only for package @cubejs-client/core

package/index.d.ts

@@ -843,6 +843,14 @@ declare module '@cubejs-client/core' {
     timeElapsed(): string;
   }
 
+  export interface UnsubscribeObj {
+    /**
+     * Allows to stop requests in-flight in long polling or web socket subscribe loops.
+     * It doesn't cancel any submitted requests to the underlying databases.
+     */
+    unsubscribe(): Promise<void>;
+  }
+
   export type SqlQueryTuple = [string, any[], any];
 
   export type SqlData = {
@@ -1045,7 +1053,7 @@ declare module '@cubejs-client/core' {
       query: QueryType,
       options?: LoadMethodOptions,
       callback?: LoadMethodCallback<ResultSet<QueryRecordType<QueryType>>>,
-    ): void;
+    ): UnsubscribeObj;
 
     load<QueryType extends DeeplyReadonly<Query | Query[]>>(
       query: QueryType,
@@ -1082,26 +1090,26 @@ declare module '@cubejs-client/core' {
       query: QueryType,
       options: LoadMethodOptions | null,
       callback: LoadMethodCallback<ResultSet<QueryRecordType<QueryType>>>,
-    ): void;
+    ): UnsubscribeObj;
 
     sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions): Promise<SqlQuery>;
     /**
      * Get generated SQL string for the given `query`.
      * @param query - [Query object](query-format)
      */
-    sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions, callback?: LoadMethodCallback<SqlQuery>): void;
+    sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions, callback?: LoadMethodCallback<SqlQuery>): UnsubscribeObj;
 
     meta(options?: LoadMethodOptions): Promise<Meta>;
     /**
      * Get meta description of cubes available for querying.
      */
-    meta(options?: LoadMethodOptions, callback?: LoadMethodCallback<Meta>): void;
+    meta(options?: LoadMethodOptions, callback?: LoadMethodCallback<Meta>): UnsubscribeObj;
 
     dryRun(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions): Promise<DryRunResponse>;
     /**
      * Get query related meta without query execution
      */
-    dryRun(query: DeeplyReadonly<Query | Query[]>, options: LoadMethodOptions, callback?: LoadMethodCallback<DryRunResponse>): void;
+    dryRun(query: DeeplyReadonly<Query | Query[]>, options: LoadMethodOptions, callback?: LoadMethodCallback<DryRunResponse>): UnsubscribeObj;
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cubejs-client/core",
-  "version": "0.31.0",
+  "version": "0.31.8",
   "engines": {},
   "repository": {
     "type": "git",
@@ -45,5 +45,5 @@
     "eslint-plugin-node": "^5.2.1",
     "jest": "^26.0.1"
   },
-  "gitHead": "8cdec759f298fb20c48194254ccc04b6fdad46bf"
+  "gitHead": "2c2eba41d75ddc3aeb81631ecd1157080162ba81"
 }