From 6aa1088a9b2e2402ab697f600bfb694cd09f7fdb Mon Sep 17 00:00:00 2001 From: Romuald Brillout Date: Thu, 18 Jul 2024 11:57:12 +0200 Subject: [PATCH] fix: improve JSDocs --- vike/shared/getPageContextUrlComputed.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/vike/shared/getPageContextUrlComputed.ts b/vike/shared/getPageContextUrlComputed.ts index d21d90fd4a6..89218bcf093 100644 --- a/vike/shared/getPageContextUrlComputed.ts +++ b/vike/shared/getPageContextUrlComputed.ts @@ -27,21 +27,21 @@ import { type Url = { /** The URL protocol, e.g. `https://` in `https://example.com` */ protocol: null | string - /** The URL origin, e.g. `https://example.com` of `https://example.com/product/42?details=yes#reviews` */ + /** The URL origin, e.g. `https://example.com` in `https://example.com/product/42?details=yes#reviews` */ origin: null | string - /** The URL pathname, e.g. `/product/42` of `https://example.com/product/42?details=yes#reviews` */ + /** The URL pathname, e.g. `/product/42` in `https://example.com/product/42?details=yes#reviews` */ pathname: string - /** URL pathname including the Base URL, e.g. `/some-base-url/product/42` of `https://example.com/some-base-url/product/42` (whereas `pageContext.urlParsed.pathname` is `/product/42`) */ + /** URL pathname including the Base URL, e.g. `/some-base-url/product/42` in `https://example.com/some-base-url/product/42` (whereas `pageContext.urlParsed.pathname` is `/product/42`) */ pathnameOriginal: string /** The URL search parameters, e.g. `{ details: 'yes' }` for `https://example.com/product/42?details=yes#reviews` */ search: Record /** The URL search parameters array, e.g. `{ fruit: ['apple', 'orange'] }` for `https://example.com?fruit=apple&fruit=orange` **/ searchAll: Record - /** The URL search parameterer string, e.g. `?details=yes` of `https://example.com/product/42?details=yes#reviews` */ + /** The URL search parameterer string, e.g. `?details=yes` in `https://example.com/product/42?details=yes#reviews` */ searchOriginal: null | string - /** The URL hash, e.g. `reviews` of `https://example.com/product/42?details=yes#reviews` */ + /** The URL hash, e.g. `reviews` in `https://example.com/product/42?details=yes#reviews` */ hash: string - /** The URL hash string, e.g. `#reviews` of `https://example.com/product/42?details=yes#reviews` */ + /** The URL hash string, e.g. `#reviews` in `https://example.com/product/42?details=yes#reviews` */ hashOriginal: null | string // TODO/v1-release: remove