36 lines
1.2 KiB
Plaintext
36 lines
1.2 KiB
Plaintext
|
interface InitOptions {
|
||
|
|
defaultStrategy?: string;
|
||
|
|
prefetchAll?: boolean;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Initialize the prefetch script, only works once.
|
||
|
|
*
|
||
|
|
* @param defaultOpts Default options for prefetching if not already set by the user config.
|
||
|
|
*/
|
||
|
|
export declare function init(defaultOpts?: InitOptions): void;
|
||
|
|
export interface PrefetchOptions {
|
||
|
|
/**
|
||
|
|
* How the prefetch should prioritize the URL. (default `'link'`)
|
||
|
|
* - `'link'`: use `<link rel="prefetch">`, has lower loading priority.
|
||
|
|
* - `'fetch'`: use `fetch()`, has higher loading priority.
|
||
|
|
*/
|
||
|
|
with?: 'link' | 'fetch';
|
||
|
|
/**
|
||
|
|
* Should prefetch even on data saver mode or slow connection. (default `false`)
|
||
|
|
*/
|
||
|
|
ignoreSlowConnection?: boolean;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Prefetch a URL so it's cached when the user navigates to it.
|
||
|
|
*
|
||
|
|
* @param url A full or partial URL string based on the current `location.href`. They are only fetched if:
|
||
|
|
* - The user is online
|
||
|
|
* - The user is not in data saver mode
|
||
|
|
* - The URL is within the same origin
|
||
|
|
* - The URL is not the current page
|
||
|
|
* - The URL has not already been prefetched
|
||
|
|
* @param opts Additional options for prefetching.
|
||
|
|
*/
|
||
|
|
export declare function prefetch(url: string, opts?: PrefetchOptions): void;
|
||
|
|
export {};
|