
Bibliothèque Node.js pour diffuser des fichiers en tant que réponses HTTP avec prise en charge du contenu partiel, des requêtes conditionnelles et des en-têtes de cache configurables. Conçue pour être utilisée dans des frameworks web comme Fastify.
Send est une bibliothèque permettant de diffuser des fichiers depuis le système de fichiers en tant que réponse HTTP, prenant en charge les réponses partielles (Ranges), la négociation conditionnelle-GET (If-Match, If-Unmodified-Since, If-None-Match, If-Modified-Since), une couverture de tests élevée, et des événements granulaires qui peuvent être exploités pour prendre les mesures appropriées dans votre application ou framework.
Il s'agit d'un module Node.js disponible via le registre npm. L'installation s'effectue à l'aide de la commande npm install :
$ npm install @fastify/send
@types/mime@3 doit être utilisé si vous souhaitez utiliser TypeScript ;
@types/mime@4 a supprimé les types mime.
$ npm install -D @types/mime@3
const send = require('@fastify/send')
Fournit statusCode, headers et stream pour le chemin donné à envoyer vers une
res. Le req est la requête HTTP Node.js et le path est un chemin encodé en URL
à envoyer (encodé en URL, pas le chemin réel du système de fichiers).
Active ou désactive l'acceptation des requêtes avec plage, par défaut true.
La désactivation n'enverra pas Accept-Ranges et ignorera le contenu
de l'en-tête de requête Range.
Active ou désactive la définition de l'en-tête de réponse Cache-Control, par défaut
true. La désactivation ignorera les options immutable et maxAge.
Par défaut, cette bibliothèque utilise le module mime pour définir le Content-Type
de la réponse en fonction de l'extension du fichier demandé.
Pour désactiver cette fonctionnalité, définissez contentType sur false.
L'en-tête Content-Type devra être défini manuellement s'il est désactivé.
Définit comment les « dotfiles » sont traités lorsqu'ils sont rencontrés. Un dotfile est un fichier
ou un répertoire qui commence par un point (« . »). Notez que cette vérification est effectuée sur
le chemin lui-même sans vérifier si le chemin existe sur le
disque. Si root est spécifié, seuls les dotfiles au-dessus de la racine sont
vérifiés (c'est-à-dire que la racine elle-même peut se trouver dans un dotfile lorsqu'elle est définie
sur « deny »).
'allow' Aucun traitement spécial pour les dotfiles.'deny' Envoie un 403 pour toute requête d'un dotfile.'ignore' Fait comme si le dotfile n'existait pas et renvoie 404.La valeur par défaut est similaire à 'ignore', à l'exception que
cette valeur par défaut n'ignorera pas les fichiers dans un répertoire qui commence
par un point, pour des raisons de rétrocompatibilité.
Décalage d'octet auquel le flux se termine, par défaut la longueur du fichier
moins 1. La fin est inclusive dans le flux, ce qui signifie que end: 3 inclura
le 4e octet du flux.
Active ou désactive la génération d'etag, par défaut true.
Si un fichier donné n'existe pas, essaie d'ajouter l'une des extensions données,
dans l'ordre donné. Par défaut, cette option est désactivée (définie sur false). Un
exemple de valeur qui servira des fichiers HTML sans extension : ['html', 'htm'].
Ceci est ignoré si le fichier demandé possède déjà une extension.
Active ou désactive la directive immutable dans l'en-tête de réponse
Cache-Control, par défaut false. Si définie sur true, l'option maxAge doit
également être spécifiée pour activer la mise en cache. La directive immutable empêchera
les clients compatibles d'effectuer des requêtes conditionnelles pendant la durée de
l'option maxAge pour vérifier si le fichier a changé.
Par défaut, send prend en charge les fichiers « index.html », pour désactiver cela
définissez false ou pour fournir un nouvel index passez une chaîne ou un tableau
dans l'ordre de préférence.
Active ou désactive l'en-tête Last-Modified, par défaut true. Utilise la valeur
de dernière modification du système de fichiers.
Fournit un max-age en millisecondes pour la mise en cache HTTP, par défaut 0. Cela peut aussi être une chaîne acceptée par le module ms.
Spécifie la taille maximale du contenu de la réponse, par défaut la taille totale du fichier.
Ceci sera utilisé lorsque acceptRanges est true.
Appelé avec le chemin absolu du fichier finalement sélectionné et les statistiques du système de fichiers
après la résolution du fichier, mais avant le traitement de la réponse et la création du flux de fichier.
Le callback peut être synchrone ou renvoyer une promesse. S'il renvoie une promesse,
send attend qu'elle soit résolue. Si le callback lève une exception ou si sa promesse renvoyée
est rejetée, l'opération est abandonnée et send() est rejeté.
Sert les fichiers relativement à path.
Décalage d'octet auquel le flux commence, par défaut 0. Le début est inclusif,
ce qui signifie que start: 2 inclura le 3e octet du flux.
Lorsqu'elle est fournie, cette option définit le nombre maximal d'octets que le tampon interne conservera avant de suspendre les lectures depuis la ressource sous-jacente. Si vous omettez cette option (ou passez undefined), Node.js revient à sa valeur par défaut intégrée pour les flux binaires lisibles.
L'export mime est l'instance globale du
module npm mime.
Il est utilisé pour configurer les types MIME associés aux extensions de fichiers ainsi que d'autres options pour déterminer le type MIME d'un fichier (comme le type par défaut à utiliser pour une extension de fichier inconnue).
Il n'effectue pas de mise en cache interne ; vous devriez utiliser un cache de proxy inverse tel que Varnish pour cela, ou ces choses sophistiquées appelées CDN. Si votre application est suffisamment petite pour bénéficier d'une mise en cache en mémoire sur un seul nœud, elle est suffisamment petite pour ne pas avoir besoin de mise en cache du tout ;).
Pour activer la sortie d'instrumentation debug(), exportez NODE_DEBUG :
$ NODE_DEBUG=send node app
$ npm install
$ npm test
Cet exemple simple enverra un fichier spécifique à toutes les requêtes.
const http = require('node:http')
const send = require('send')
const server = http.createServer(async function onRequest (req, res) {
const { statusCode, headers, stream } = await send(req, '/path/to/index.html')
res.writeHead(statusCode, headers)
stream.pipe(res)
})
server.listen(3000)
Cet exemple simple se contentera de servir tous les fichiers d'un
répertoire donné au niveau racine. Par exemple, une requête
GET /foo.txt renverra /www/public/foo.txt.
const http = require('node:http')
const parseUrl = require('parseurl')
const send = require('@fastify/send')
const server = http.createServer(async function onRequest (req, res) {
const { statusCode, headers, stream } = await send(req, parseUrl(req).pathname, { root: '/www/public' })
res.writeHead(statusCode, headers)
stream.pipe(res)
})
server.listen(3000)