feat(bus): change the return value of touchBus

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.2] - 2021-09-03
+### Changed
+- change the return value of touchBus
 ## [0.3.1] - 2021-09-02
 ### Added
 - new Api: touchBus

README.md

@@ -30,7 +30,7 @@ umd:
 
 In host enviroment, create a bus and declare the resource info
 ```js
-import {touchBus} from 'obvious-core';
+import { touchBus } from 'obvious-core';
 
 const [bus] = touchBus()
 bus.config({
@@ -58,7 +58,7 @@ react-app
 ```js
 import React from 'react';
 import ReactDOM from 'react-dom';
-import {touchBus} from 'obvious-core';
+import { touchBus } from 'obvious-core';
 
 const [bus] = touchBus();
 const socket = bus.createSocket();
@@ -75,7 +75,7 @@ vue-app
 ```js
 import Vue from 'vue';
 import App from './App.vue';
-import {touchBus} from 'obvious-core';
+import { touchBus } from 'obvious-core';
 
 Vue.config.productionTip = false;
 

README.zh.md

@@ -27,7 +27,7 @@ umd:
 ## 快速开始
 在宿主环境中创建bus，并声明微应用资源
 ```js
-import {touchBus} from 'obvious-core';
+import { touchBus } from 'obvious-core';
 
 const [bus] = touchBus();
 
@@ -56,9 +56,9 @@ react-app
 ```js
 import React from 'react';
 import ReactDOM from 'react-dom';
-import {touchBus} from 'obvious-core';
+import { touchBus } from 'obvious-core';
 
-const bus = touchBus('host');
+const bus = touchBus();
 const socket = bus.createSocket();
 bus.createApp('react-app')
   .bootstrap(async (config) => {
@@ -73,11 +73,11 @@ vue-app
 ```js
 import Vue from 'vue';
 import App from './App.vue';
-import {touchBus} from 'obvious-core';
+import { touchBus } from 'obvious-core';
 
 Vue.config.productionTip = false;
 
-const [bus] = touchBus('host');
+const [bus] = touchBus();
 const socket = bus.createSocket();
 bus.createApp('vue-app')
   .bootstrap(async (config) => {

dist/index.es.js

@@ -1094,17 +1094,17 @@ var getBus = function (name) {
 var touchBus = function (name) {
     if (name === void 0) { name = DEFAULT_BUS_NAME; }
     var bus = null;
-    var isBusAlreadyExists = false;
+    var isHost = false;
     var existedBus = getBus(name);
     if (existedBus) {
         bus = existedBus;
-        isBusAlreadyExists = true;
+        isHost = false;
     }
     else {
         bus = createBus(name);
-        isBusAlreadyExists = false;
+        isHost = true;
     }
-    return [bus, isBusAlreadyExists];
+    return [bus, isHost];
 };
 
 var Obvious = {

dist/index.umd.js

@@ -1100,17 +1100,17 @@
     var touchBus = function (name) {
         if (name === void 0) { name = DEFAULT_BUS_NAME; }
         var bus = null;
-        var isBusAlreadyExists = false;
+        var isHost = false;
         var existedBus = getBus(name);
         if (existedBus) {
             bus = existedBus;
-            isBusAlreadyExists = true;
+            isHost = false;
         }
         else {
             bus = createBus(name);
-            isBusAlreadyExists = false;
+            isHost = true;
         }
-        return [bus, isBusAlreadyExists];
+        return [bus, isHost];
     };
 
     var Obvious = {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obvious-core",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "a  progressive micro front framework",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",

src/lib/bus.ts

@@ -266,14 +266,14 @@ export const getBus = (name: string = DEFAULT_BUS_NAME) => {
  */
 export const touchBus = (name: string = DEFAULT_BUS_NAME): [Bus, boolean] => {
   let bus: Bus = null;
-  let isBusAlreadyExists: boolean = false;
+  let isHost: boolean = false;
   const existedBus = getBus(name);
   if (existedBus) {
     bus = existedBus;
-    isBusAlreadyExists = true;
+    isHost = false;
   } else {
     bus = createBus(name);
-    isBusAlreadyExists = false;
+    isHost = true;
   }
-  return [bus, isBusAlreadyExists];
+  return [bus, isHost];
 };

test/bus.test.ts

@@ -129,14 +129,14 @@ describe('Test the capability to load the resources of an app or lib', () => {
   });
 
   test('# case 6: test touchBus and default bus', () => {
-    const [testBus, isTestBusAlreadyExists] = touchBus('testBus');
-    expect(isTestBusAlreadyExists).toBeTruthy();
+    const [testBus, isTestBusHost] = touchBus('testBus');
+    expect(isTestBusHost).toBeFalsy();
     expect(testBus).toEqual(bus);
-    const [defaultBus1, isDefaultBus1AlreadyExists] = touchBus();
-    expect(isDefaultBus1AlreadyExists).toBeFalsy();
+    const [defaultBus1, isDefaultBus1Host] = touchBus();
+    expect(isDefaultBus1Host).toBeTruthy();
     expect(defaultBus1).toEqual(window.__Bus__[DEFAULT_BUS_NAME]);
-    const [defaultBus2, isDefaultBus2AlreadyExists] = touchBus();
-    expect(isDefaultBus2AlreadyExists).toBeTruthy();
+    const [defaultBus2, isDefaultBus2Host] = touchBus();
+    expect(isDefaultBus2Host).toBeFalsy();
     expect(defaultBus2).toEqual(defaultBus1);
   });