Export types for options objects

packages/history/index.ts

@@ -328,12 +328,6 @@ export interface MemoryHistory<S extends State = State> extends History<S> {
   index: number;
 }
 
-/**
- * Describes an entry in the history stack. Useful when providing entries to
- * {@link createMemoryHistory} via its `initialEntries` option.
- */
-export type InitialEntry = Path | LocationPieces;
-
 const readOnly: <T extends unknown>(obj: T) => T = __DEV__
   ? obj => Object.freeze(obj)
   : obj => obj;
@@ -369,14 +363,20 @@ const BeforeUnloadEventType = 'beforeunload';
 const HashChangeEventType = 'hashchange';
 const PopStateEventType = 'popstate';
 
+/**
+ * The type of options that are available in {@link createBrowserHistory}.
+ */
+export type BrowserHistoryOptions = { window?: Window };
+
 /**
  * Browser history stores the location in regular URLs. This is the standard for
  * most web apps, but it requires some configuration on the server to ensure you
  * serve the same app at multiple URLs.
  */
-export function createBrowserHistory({
-  window = document.defaultView as Window
-}: { window?: Window } = {}): BrowserHistory {
+export function createBrowserHistory(
+  options: BrowserHistoryOptions = {}
+): BrowserHistory {
+  let { window = document.defaultView! } = options;
   let globalHistory = window.history;
 
   function getIndexAndLocation(): [number, Location] {
@@ -582,15 +582,21 @@ export function createBrowserHistory({
 // HASH
 ////////////////////////////////////////////////////////////////////////////////
 
+/**
+ * The type of options that are available in {@link createHashHistory}.
+ */
+export type HashHistoryOptions = { window?: Window };
+
 /**
  * Hash history stores the location in window.location.hash. This makes it ideal
  * for situations where you don't want to send the location to the server for
  * some reason, either because you do cannot configure it or the URL space is
  * reserved for something else.
  */
-export function createHashHistory({
-  window = document.defaultView as Window
-}: { window?: Window } = {}): HashHistory {
+export function createHashHistory(
+  options: HashHistoryOptions = {}
+): HashHistory {
+  let { window = document.defaultView! } = options;
   let globalHistory = window.history;
 
   function getIndexAndLocation(): [number, Location] {
@@ -836,18 +842,29 @@ export function createHashHistory({
 // MEMORY
 ////////////////////////////////////////////////////////////////////////////////
 
+/**
+ * Describes an entry in the history stack. Useful when providing entries to
+ * {@link createMemoryHistory} via its `initialEntries` option.
+ */
+export type InitialEntry = Path | LocationPieces;
+
+/**
+ * The type of options that are available in {@link createMemoryHistory}.
+ */
+export type MemoryHistoryOptions = {
+  initialEntries?: InitialEntry[];
+  initialIndex?: number;
+};
+
 /**
  * Memory history stores the current location in memory. It is designed for use
  * in stateful non-browser environments like headless tests (in node.js) and
  * React Native.
  */
-export function createMemoryHistory({
-  initialEntries = ['/'],
-  initialIndex
-}: {
-  initialEntries?: InitialEntry[];
-  initialIndex?: number;
-} = {}): MemoryHistory {
+export function createMemoryHistory(
+  options: MemoryHistoryOptions = {}
+): MemoryHistory {
+  let { initialEntries = ['/'], initialIndex } = options;
   let entries: Location[] = initialEntries.map(entry => {
     let location = readOnly<Location>({
       pathname: '/',