Move identifier to options object for getImmediate()

Author: Feiyang1

packages/component/index.ts

@@ -18,4 +18,4 @@
 export { Component } from './src/component';
 export { ComponentContainer } from './src/component_container';
 export { Provider } from './src/provider';
-export { ComponentType, InstanceFactory } from './src/types';
+export { ComponentType, InstanceFactory, InstantiationMode } from './src/types';

packages/component/package.json

@@ -22,17 +22,17 @@
     "prepare": "yarn build"
   },
   "dependencies": {
-    "@firebase/util": "0.2.29",
+    "@firebase/util": "0.2.31",
     "tslib": "1.10.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/chai": "4.2.3",
+    "@types/chai": "4.2.4",
     "@types/mocha": "5.2.7",
     "@types/sinon": "7.5.0",
     "chai": "4.2.0",
     "chai-as-promised": "7.1.1",
-    "karma": "4.3.0",
+    "karma": "4.4.1",
     "sinon": "7.5.0",
     "sinon-chai": "3.3.0",
     "karma-chrome-launcher": "3.1.0",
@@ -43,19 +43,19 @@
     "karma-sauce-launcher": "1.2.0",
     "karma-spec-reporter": "0.0.32",
     "karma-webpack": "4.0.2",
-    "mocha": "6.2.1",
+    "mocha": "6.2.2",
     "npm-run-all": "4.1.5",
     "nyc": "14.1.1",
-    "rollup": "1.23.1",
+    "rollup": "1.25.2",
     "rollup-plugin-typescript2": "0.24.3",
-    "ts-loader": "6.2.0",
+    "ts-loader": "6.2.1",
     "ts-node": "8.4.1",
     "typescript": "3.6.4",
-    "webpack": "4.41.1",
+    "webpack": "4.41.2",
     "eslint": "6.5.1",
-    "@typescript-eslint/parser": "2.4.0",
-    "@typescript-eslint/eslint-plugin": "2.4.0",
-    "@typescript-eslint/eslint-plugin-tslint": "2.4.0",
+    "@typescript-eslint/parser": "2.5.0",
+    "@typescript-eslint/eslint-plugin": "2.5.0",
+    "@typescript-eslint/eslint-plugin-tslint": "2.5.0",
     "eslint-plugin-import": "2.18.2"
   },
   "repository": {

packages/component/src/provider.test.ts

@@ -49,7 +49,7 @@ describe('Provider', () => {
       });
 
       it('returns null if the service is not available with optional flag', () => {
-        expect(provider.getImmediate(undefined, { optional: true })).to.equal(
+        expect(provider.getImmediate({ optional: true })).to.equal(
           null
         );
       });
@@ -69,8 +69,8 @@ describe('Provider', () => {
       it('ignores parameter identifier and return the default service', () => {
         provider.setComponent(getFakeComponent('test', () => ({ test: true })));
         const defaultService = provider.getImmediate();
-        expect(provider.getImmediate('spider1')).to.equal(defaultService);
-        expect(provider.getImmediate('spider2')).to.equal(defaultService);
+        expect(provider.getImmediate({identifier: 'spider1'})).to.equal(defaultService);
+        expect(provider.getImmediate({identifier: 'spider2'})).to.equal(defaultService);
       });
     });
 
@@ -187,11 +187,11 @@ describe('Provider', () => {
   describe('Provider (multipleInstances = true)', () => {
     describe('getImmediate(identifier)', () => {
       it('throws if the service is not available', () => {
-        expect(provider.getImmediate.bind(provider, 'guardian')).to.throw();
+        expect(provider.getImmediate.bind(provider, {identifier: 'guardian'})).to.throw();
       });
 
       it('returns null if the service is not available with optional flag', () => {
-        expect(provider.getImmediate('guardian', { optional: true })).to.equal(
+        expect(provider.getImmediate({ identifier: 'guardian', optional: true })).to.equal(
           null
         );
       });
@@ -201,8 +201,8 @@ describe('Provider', () => {
           getFakeComponent('test', () => ({ test: true }), true)
         );
         const defaultService = provider.getImmediate();
-        const service1 = provider.getImmediate('guardian');
-        const service2 = provider.getImmediate('servant');
+        const service1 = provider.getImmediate({identifier: 'guardian'});
+        const service2 = provider.getImmediate({identifier: 'servant'});
 
         expect(defaultService).to.deep.equal({ test: true });
         expect(service1).to.deep.equal({ test: true });
@@ -296,8 +296,8 @@ describe('Provider', () => {
         provider.setComponent(getFakeComponent('test', getService, true));
 
         // create 2 service instances with different names
-        provider.getImmediate('instance1');
-        provider.getImmediate('instance2');
+        provider.getImmediate({identifier: 'instance1'});
+        provider.getImmediate({identifier: 'instance2'});
 
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         provider.delete();
@@ -313,7 +313,7 @@ describe('Provider', () => {
         provider.setComponent(getFakeComponent('test', () => ({}), true));
         // create serviec instances with different identifiers
         const defaultInstance = provider.getImmediate();
-        const instance1 = provider.getImmediate('instance1');
+        const instance1 = provider.getImmediate({identifier: 'instance1'});
 
         expect((provider as any).instances.size).to.equal(2);
 
@@ -327,7 +327,7 @@ describe('Provider', () => {
         // remove the named instance from cache and create a new instance with the same identifier
         provider.clearInstance('instance1');
         expect((provider as any).instances.size).to.equal(1);
-        const newInstance1 = provider.getImmediate('instance1');
+        const newInstance1 = provider.getImmediate({identifier: 'instance1'});
         expect(newInstance1).to.not.eq(instance1);
         expect((provider as any).instances.size).to.equal(2);
       });

packages/component/src/provider.ts

@@ -32,8 +32,12 @@ export class Provider<T = unknown> {
   constructor(
     private readonly name: string,
     private readonly container: ComponentContainer
-  ) {}
+  ) { }
 
+  /**
+   * @param identifier A provider can provide mulitple instances of a service 
+   * if this.component.multipleInstances is true.
+   */
   get(identifier: string = DEFAULT_ENTRY_NAME): Promise<T> {
     // if multipleInstances is not supported, use the default name
     const normalizedIdentifier = this.normalizeInstanceIdentifier(identifier);
@@ -51,22 +55,40 @@ export class Provider<T = unknown> {
     return this.instancesDeferred.get(normalizedIdentifier)!.promise;
   }
 
+/**
+ * 
+ * @param options.identifier A provider can provide mulitple instances of a service 
+   * if this.component.multipleInstances is true.
+ * @param options.optional If optional is false or not provided, the method throws an error when
+ * the service is not immediately available.
+ * If optional is true, the method returns null if the service is not immediately available.
+ */
   getImmediate(
-    identifier: string | undefined,
-    options: { optional: true }
+    options: {
+      identifier?: string
+      optional: true
+    }
   ): T | null;
-  getImmediate(identifier?: string, options?: { optional: false }): T;
   getImmediate(
-    identifier: string = DEFAULT_ENTRY_NAME,
-    options?: { optional: boolean }
+    options?: {
+      identifier?: string,
+      optional?: false
+    }): T;
+  getImmediate(
+    options?: {
+      identifier?: string,
+      optional?: boolean
+    }
   ): T | null {
+
+    const { identifier, optional } = { identifier: DEFAULT_ENTRY_NAME, optional: false, ...options };
     // if multipleInstances is not supported, use the default name
     const normalizedIdentifier = this.normalizeInstanceIdentifier(identifier);
 
     const instance = this.getOrInitializeService(normalizedIdentifier);
 
     if (!instance) {
-      if (options && options.optional) {
+      if (optional) {
         return null;
       }
       throw Error(`Service ${this.name} is not available`);

packages/component/src/types.ts

@@ -48,6 +48,6 @@ export type InstanceFactory<T = unknown> = (
   instanceIdentifier?: string
 ) => T;
 
-export type Dictionary = {
+export interface Dictionary {
   [key: string]: unknown;
 };