Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Allow defining additional location descriptor types #350

Merged
merged 2 commits into from
Jul 31, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down