
Node.js लाइब्रेरी जो फ़ाइलों को HTTP प्रतिक्रियाओं के रूप में स्ट्रीम करने के लिए है, जिसमें आंशिक सामग्री, सशर्त अनुरोध और कॉन्फ़िगरेबल कैशिंग हेडर का समर्थन है। वेब फ्रेमवर्क जैसे Fastify में उपयोग के लिए डिज़ाइन किया गया है।
Send एक लाइब्रेरी है जो फ़ाइल सिस्टम से फ़ाइलों को HTTP प्रतिक्रिया के रूप में स्ट्रीम करने के लिए है, जो आंशिक प्रतिक्रियाओं (Ranges), सशर्त-GET नेगोशिएशन (If-Match, If-Unmodified-Since, If-None-Match, If-Modified-Since), उच्च परीक्षण कवरेज, और सूक्ष्म इवेंट्स का समर्थन करती है, जिनका उपयोग आपके एप्लिकेशन या फ्रेमवर्क में उपयुक्त कार्रवाई करने के लिए किया जा सकता है।
यह एक Node.js मॉड्यूल है जो npm रजिस्ट्री के माध्यम से उपलब्ध है। इंस्टॉलेशन npm install कमांड का उपयोग करके किया जाता है:
$ npm install @fastify/send
TypeScript का उपयोग करना हो तो @types/mime@3 का उपयोग करना आवश्यक है;
@types/mime@4 ने mime प्रकारों को हटा दिया है।
$ npm install -D @types/mime@3
const send = require('@fastify/send')
दिए गए path के लिए statusCode, headers, और stream प्रदान करें ताकि
res को भेजा जा सके। req Node.js HTTP request है और path एक urlencoded path है
जिसे भेजना है (urlencoded, वास्तविक file-system path नहीं)।
ranged requests स्वीकार करने को सक्षम या अक्षम करें, डिफ़ॉल्ट true है।
इसे अक्षम करने पर Accept-Ranges नहीं भेजा जाएगा और Range request header
की सामग्री को अनदेखा किया जाएगा।
Cache-Control response header सेट करने को सक्षम या अक्षम करें, डिफ़ॉल्ट true है।
इसे अक्षम करने पर immutable और maxAge options को अनदेखा किया जाएगा।
डिफ़ॉल्ट रूप से, यह library अनुरोधित फ़ाइल के file extension के आधार पर
response का Content-Type सेट करने के लिए mime module का उपयोग करती है।
इस कार्यक्षमता को अक्षम करने के लिए, contentType को false पर सेट करें।
अक्षम होने पर Content-Type header को मैन्युअल रूप से सेट करना होगा।
"dotfiles" के सामने आने पर उनके साथ कैसा व्यवहार किया जाए, यह सेट करें। dotfile वह फ़ाइल
या directory है जो एक dot (".") से शुरू होती है। ध्यान दें कि यह जाँच path पर ही की जाती है
बिना यह जाँचे कि path disk पर मौजूद है या नहीं। यदि root निर्दिष्ट है, तो केवल root के ऊपर
वाले dotfiles की जाँच की जाती है (अर्थात् "deny" पर सेट होने पर root स्वयं एक dotfile के भीतर हो सकता है)।
'allow' dotfiles के लिए कोई विशेष व्यवहार नहीं।'deny' dotfile के किसी भी अनुरोध के लिए 403 भेजें।'ignore' ऐसा दिखावा करें जैसे dotfile मौजूद ही नहीं है और 404 भेजें।डिफ़ॉल्ट मान 'ignore' के समान है, सिवाय इसके कि यह डिफ़ॉल्ट backward-compatibility
के लिए dot से शुरू होने वाली directory के भीतर की फ़ाइलों को अनदेखा नहीं करेगा।
वह byte offset जहाँ stream समाप्त होता है, डिफ़ॉल्ट रूप से फ़ाइल की लंबाई
घटाकर 1। stream में end समावेशी है, अर्थात् end: 3 stream में
चौथा byte शामिल करेगा।
etag निर्माण को सक्षम या अक्षम करें, डिफ़ॉल्ट true है।
यदि दी गई फ़ाइल मौजूद नहीं है, तो दिए गए क्रम में दिए गए extensions में से
एक जोड़कर देखें। डिफ़ॉल्ट रूप से, यह अक्षम है (false पर सेट)। एक
उदाहरण मान जो बिना extension वाली HTML फ़ाइलों को serve करेगा: ['html', 'htm']।
यदि अनुरोधित फ़ाइल में पहले से ही extension है तो इसे छोड़ दिया जाता है।
Cache-Control response header में immutable directive को सक्षम या अक्षम करें,
डिफ़ॉल्ट false है। यदि true पर सेट किया जाए, तो caching सक्षम करने के लिए
maxAge option भी निर्दिष्ट किया जाना चाहिए। immutable directive समर्थित clients को
यह जाँचने से रोकेगा कि फ़ाइल बदली है या नहीं, maxAge option के जीवनकाल के दौरान
conditional requests करने से।
डिफ़ॉल्ट रूप से send "index.html" फ़ाइलों का समर्थन करता है, इसे अक्षम करने के लिए
false सेट करें या नया index देने के लिए पसंदीदा क्रम में एक string या array पास करें।
Last-Modified header को सक्षम या अक्षम करें, डिफ़ॉल्ट true है। file
system के last modified मान का उपयोग करता है।
HTTP caching के लिए milliseconds में max-age प्रदान करें, डिफ़ॉल्ट 0 है। यह ms module द्वारा स्वीकार की जाने वाली string भी हो सकती है।
अधिकतम response content आकार निर्दिष्ट करें, डिफ़ॉल्ट पूरा file size है।
इसका उपयोग तब किया जाएगा जब acceptRanges true हो।
file resolution के बाद, लेकिन response processing और file stream creation से पहले,
अंतिम चयनित फ़ाइल के absolute path और file system statistics के साथ कॉल किया जाता है।
callback synchronous हो सकता है या promise लौटा सकता है। यदि यह promise लौटाता है,
तो send इसके settle होने की प्रतीक्षा करता है। यदि callback throw करता है या इसका लौटाया गया promise
reject होता है, तो operation निरस्त कर दिया जाता है और send() reject होता है।
path के सापेक्ष फ़ाइलें serve करें।
वह byte offset जहाँ stream शुरू होता है, डिफ़ॉल्ट 0 है। start समावेशी है,
अर्थात् start: 2 stream में तीसरा byte शामिल करेगा।
प्रदान किए जाने पर, यह option अधिकतम bytes की संख्या सेट करता है जो internal buffer अंतर्निहित resource से reads को रोकने से पहले धारण करेगा। यदि आप इस option को छोड़ देते हैं (या undefined पास करते हैं), तो Node.js readable binary streams के लिए अपने अंतर्निहित डिफ़ॉल्ट पर वापस चला जाता है।
mime एक्सपोर्ट mime npm मॉड्यूल का ग्लोबल इंस्टेंस है।
इसका उपयोग उन MIME प्रकारों को कॉन्फ़िगर करने के लिए किया जाता है जो फ़ाइल एक्सटेंशन से जुड़े होते हैं, साथ ही किसी फ़ाइल के MIME प्रकार को हल करने के तरीके के लिए अन्य विकल्पों (जैसे किसी अज्ञात फ़ाइल एक्सटेंशन के लिए उपयोग किया जाने वाला डिफ़ॉल्ट प्रकार) के लिए भी।
यह आंतरिक कैशिंग नहीं करता है, इसके लिए आपको Varnish जैसे रिवर्स प्रॉक्सी कैश का उपयोग करना चाहिए, या उन शानदार चीज़ों का जिन्हें CDN कहा जाता है। यदि आपका एप्लिकेशन इतना छोटा है कि उसे सिंगल-नोड मेमोरी कैशिंग से लाभ होगा, तो यह इतना छोटा है कि इसे कैशिंग की बिल्कुल भी आवश्यकता नहीं है ;)।
debug() इंस्ट्रुमेंटेशन आउटपुट सक्षम करने के लिए NODE_DEBUG एक्सपोर्ट करें:
$ NODE_DEBUG=send node app
$ npm install
$ npm test
यह सरल उदाहरण सभी अनुरोधों के लिए एक विशिष्ट फ़ाइल भेजेगा।
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)
यह सरल उदाहरण किसी दी गई निर्देशिका की सभी फ़ाइलों को
शीर्ष-स्तर के रूप में सर्व करेगा। उदाहरण के लिए, एक अनुरोध
GET /foo.txt वापस /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)
const http = require('node:http')
const parseUrl = require('parseurl')
const send = require('@fastify/send')
// Default unknown types to text/plain
send.mime.default_type = 'text/plain'
// Add a custom type
send.mime.define({
'application/x-my-type': ['x-mt', 'x-mtt']
})