@cloudflare/kv-asset-handler

@cloudflare/kv-asset-handler

Installation

Add this package to your package.json by running this in the root of your project's directory:

npm i @cloudflare/kv-asset-handler

Usage

Currently this exports a single function getAssetFromKV that maps Request objects to KV Assets, and throws an Error if it cannot.

import { getAssetFromKV } from '@cloudflare/kv-asset-handler'

getAssetFromKV is a function that takes a Request object and returns a Response object if the request matches an asset in KV, otherwise it will throw an Error.

Note this package was designed to work with Worker Sites. If you are not using Sites make sure to call the bucket you are serving assets from __STATIC_CONTENT

Example

This example checks for the existence of a value in KV, and returns it if it's there, and returns a 404 if it is not. It also serves index.html from /.

import { getAssetFromKV } from '@cloudflare/kv-asset-handler'

addEventListener('fetch', event => {
  event.respondWith(handleRequest(event.request))
})
const customKeyModifier = url => {
  //custom key mapping optional
  if (url.endsWith('/')) url += 'index.html'
  return url.replace('/docs', '').replace(/^\/+/, '')
}
async function handleRequest(request) {
  if (request.url.includes('/docs')) {
    try {
      return await getAssetFromKV(request, customKeyModifier)
    } catch (e) {
      return new Response(`"${customKeyModifier(request.url)}" not found`, {
        status: 404,
        statusText: 'not found',
      })
    }
  } else return fetch(request)
}