feat: Allow defining additional location descriptor types (#350)

4Catalyzer · Jul 31, 2020 · 759028f · 759028f
1 parent 2d4ff36
commit 759028f
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -80,7 +80,16 @@ export interface LocationDescriptorObject {
  *
  * https://github.com/4Catalyzer/farce#locations-and-location-descriptors
  */
-export type LocationDescriptor = LocationDescriptorObject | string;
+export type LocationDescriptorString = string;
+
+// Using an interface allows consumers to use object merging to add other
+//  location descriptor types.
+export interface LocationDescriptorTypes {
+  object: LocationDescriptorObject;
+  string: LocationDescriptorString;
+}
+
+export type LocationDescriptor = LocationDescriptorTypes[keyof LocationDescriptorTypes];
 
 export interface HistoryEnhancerOptions {
   protocol: Protocol;