indexnow.mjs

Functions

Imports

It imports no other module of this repo. No module of this repo imports it.

Source

1const ENDPOINT = "https://api.indexnow.org/indexnow";
2
3/**
4 * @typedef {object} IndexNowInput
5 * @property {string} origin the production origin; IndexNow refuses a URL on any other host, so those are dropped
6 * @property {string} key the site's IndexNow key, served as the whole body of `keyLocation`
7 * @property {string[]} urls the changed pages
8 * @property {string} [keyLocation] defaults to `${origin}/${key}.txt`
9 * @property {string} [from] the URL of the request that made the change; a request on any other origin (localhost, a
10 *   workers.dev preview) sends nothing
11 * @property {typeof fetch} [fetch]
12 */
13
14/**
15 * Tell Bing, Yandex and the other IndexNow engines that pages changed, instead of waiting for their next crawl. Never throws:
16 * a network error or a non-2xx answer resolves to false, since a missed ping only means the engine finds the page on its own
17 * schedule. On Workers, hand the promise to `ctx.waitUntil` so the response never waits on it.
18 *
19 * @param {IndexNowInput} input
20 * @returns {Promise<boolean>}
21 */
22export async function submitIndexNow({ origin, key, urls, keyLocation, from, fetch: fetcher = fetch }) {
23  try {
24    if (from !== undefined && new URL(from).origin !== origin) return false;
25    const urlList = urls.filter((url) => url.startsWith(`${origin}/`));
26    if (urlList.length === 0) return false;
27    const response = await fetcher(ENDPOINT, {
28      method: "POST",
29      headers: { "Content-Type": "application/json; charset=utf-8" },
30      body: JSON.stringify({
31        host: new URL(origin).host,
32        key,
33        keyLocation: keyLocation ?? `${origin}/${key}.txt`,
34        urlList,
35      }),
36    });
37    return response.ok;
38  } catch {
39    return false;
40  }
41}