Restore the State export in the types

remix-run · Nov 2, 2021 · eb6ca11 · eb6ca11
1 parent 792a8fa
commit eb6ca11
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/history/index.ts b/packages/history/index.ts
@@ -48,6 +48,14 @@ export type Search = string;
  */
 export type Hash = string;
 
+/**
+ * An object that is used to associate some arbitrary data with a location, but
+ * that does not appear in the URL path.
+ *
+ * @see https://github.com/ReactTraining/history/tree/master/docs/api-reference.md#location.state
+ */
+export type State = object | null;
+
 /**
  * A unique string associated with a location. May be used to safely store
  * and retrieve data in some other storage API, like `localStorage`.