jake/get-canonical-url
1
Fork 0
mirror of https://github.com/jakejarvis/get-canonical-url.git synced 2025-04-26 00:45:22 -04:00
Code Issues Releases Activity

fix index.d.ts formatting

Browse Source
This commit is contained in:
Jake Jarvis 2021-09-30 07:54:53 -04:00
parent b27a37defd
commit 1beae5cb32
Signed by: jake
GPG Key ID: 2B0C9CF251E69A39
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/index.d.ts vendored
View File

@ -11,19 +11,19 @@ export interface Options {
/**
* Options passed directly to [`normalize-url`](https://github.com/sindresorhus/normalize-url#options).
*
* Requires options.normalize = true.
* Requires `options.normalize = true`.
*
* @default { stripWWW: false, stripHash: true, removeQueryParameters: true, removeTrailingSlash: false }
*/
readonly normalizeOptions?: NormalizeOptions;
/**
* Make an educated guess using other clues if canonical isn't explicitly set in the page's <head>.
* Make an educated guess using other clues if canonical isn't explicitly set in the page's `<head>`.
*
* @default false
*/
readonly guess?: boolean;
};
}
/**
* Returns the current page's canonical URL.