From e42e93d405fcd12eaf814fe433ac3b49432de0b8 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Fri, 20 Aug 2021 10:55:44 +0200 Subject: [PATCH] chore: comment --- src/query.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/query.ts b/src/query.ts index 1074c8c7..21142e1c 100644 --- a/src/query.ts +++ b/src/query.ts @@ -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 */ -- 2.47.2