]> git.ipfire.org Git - thirdparty/vuejs/router.git/commitdiff
docs: doc createWebHashHistory
authorEduardo San Martin Morote <posva13@gmail.com>
Tue, 19 May 2020 10:01:00 +0000 (12:01 +0200)
committerEduardo San Martin Morote <posva13@gmail.com>
Tue, 19 May 2020 10:01:06 +0000 (12:01 +0200)
src/history/hash.ts

index 1c1286be5c4ff2732ffda1baffa6c937ff89a8be..98f7241cd180f4b01bee118f9e9171f7ffca8683 100644 (file)
@@ -1,6 +1,11 @@
 import { RouterHistory } from './common'
 import { createWebHistory } from './html5'
 
+/**
+ * Creates a hash history.
+ *
+ * @param base optional base to provide. Defaults to `/`
+ */
 export function createWebHashHistory(base: string = '/'): RouterHistory {
   // Make sure this implementation is fine in terms of encoding, specially for IE11
   return createWebHistory(location.host ? base + '#' : '#')