https://github.com/dburles/modulepreload-express

Express middleware for generating modulepreload link relations for a Link entity-header based on the requested JavaScript modules import graph.
https://github.com/dburles/modulepreload-express

esm esmodules express header http link middleware modulepreload

Last synced: about 2 months ago
JSON representation

Express middleware for generating modulepreload link relations for a Link entity-header based on the requested JavaScript modules import graph.

• Host: GitHub
• URL: https://github.com/dburles/modulepreload-express
• Owner: dburles
• License: mit
• Created: 2023-10-05T23:36:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-17T23:42:39.000Z (4 months ago)
• Last Synced: 2024-09-19T00:52:11.208Z (4 months ago)
• Topics: esm, esmodules, express, header, http, link, middleware, modulepreload
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/modulepreload-express
• Size: 10.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# modulepreload-express

Express middleware for generating [modulepreload](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/modulepreload) link relations for a [Link](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link) entity-header based on the requested JavaScript modules import graph. This will prevent request waterfalls for nested module imports. Supports import maps.

## Install

```sh

npm i modulepreload-express

```

## Usage example

```js

import express from "express";

import createModulePreloadMiddleware from "modulepreload-express/createModulePreloadMiddleware.mjs";

const app = express();

const APP_ROOT = "app";

app.use(createModulePreloadMiddleware(APP_ROOT));

app.use(express.static(APP_ROOT));

app.listen(3000);

```

## API

### `createModulePreloadMiddleware(path[, options])`

- `path` {string} Path to the application root directory, eg "app".

- `options` {Object}

  - `extensions` {Array<string>} The file extensions to consider for module scripts. Defaults to: `["mjs", "js"]`.

  - `importMap` {string} Import map string.

  - `cache` {Object} A custom (map-like) cache.