refactor: rename custom type options (#773)

Author: kwasniew

README.md

@@ -234,8 +234,8 @@ catching typos at compile time.
 import { initialize } from 'unleash-client';
 
 declare module 'unleash-client' {
-  interface CustomTypeOptions {
-    name: 'aaa' | 'bbb';
+  interface UnleashTypes {
+    flagNames: 'aaa' | 'bbb';
   }
 }
 

src/client.ts

@@ -22,17 +22,17 @@ interface BooleanMap {
  * Users can extend this via module augmentation:
  *
  * declare module 'unleash-client' {
- *   interface CustomTypeOptions {
- *     name: string;
+ *   interface UnleashTypes {
+ *     flagNames: string;
  *   }
  * }
  */
-export interface CustomTypeOptions {}
+export interface UnleashTypes {}
 
-type GetCustom<K extends PropertyKey, Fallback> = K extends keyof CustomTypeOptions
-  ? CustomTypeOptions[K]
+type GetCustom<K extends PropertyKey, Fallback> = K extends keyof UnleashTypes
+  ? UnleashTypes[K]
   : Fallback;
-export type Name = GetCustom<'name', string>;
+export type Name = GetCustom<'flagNames', string>;
 
 export default class UnleashClient extends EventEmitter {
   private repository: RepositoryInterface;

src/index.ts

@@ -7,14 +7,14 @@ import { UnleashEvents } from './events';
 import { ClientFeaturesResponse } from './feature';
 import InMemStorageProvider from './repository/storage-provider-in-mem';
 import { UnleashConfig } from './unleash-config';
-import { CustomTypeOptions, Name } from './client';
+import { UnleashTypes, Name } from './client';
 
 // exports
 export { Strategy } from './strategy/index';
 export { Context, Variant, PayloadType, Unleash, TagFilter, InMemStorageProvider, UnleashEvents };
 export type { ClientFeaturesResponse, UnleashConfig };
 export { UnleashMetricClient } from './impact-metrics/metric-client';
-export { CustomTypeOptions, Name };
+export { UnleashTypes, Name };
 
 let instance: undefined | Unleash;