]> git.ipfire.org Git - thirdparty/vuejs/router.git/commitdiff
chore: comment
authorEduardo San Martin Morote <posva13@gmail.com>
Fri, 20 Aug 2021 08:55:44 +0000 (10:55 +0200)
committerEduardo San Martin Morote <posva13@gmail.com>
Fri, 20 Aug 2021 08:55:44 +0000 (10:55 +0200)
src/query.ts

index 1074c8c72c8ee69d4cc8447477c668bf34508542..21142e1c23bc3a628dd3279d869f717f35f53097 100644 (file)
@@ -2,8 +2,14 @@ import { decode, encodeQueryKey, encodeQueryValue, PLUS_RE } from './encoding'
 
 /**
  * Possible values in normalized {@link LocationQuery}. `null` renders the query
- * param but without an `=`: `?isNull&isEmpty=&other=other` -> `{ isNull: null,
- * isEmpty: '', other: 'other' }`.
+ * param but without an `=`.
+ *
+ * @example
+ * ```
+ * ?isNull&isEmpty=&other=other
+ * gives
+ * `{ isNull: null, isEmpty: '', other: 'other' }`.
+ * ```
  *
  * @internal
  */