{"_id":"@charlypoirier/uwebsocket-serve","_rev":"1-bacd385f9d39a33c62e3cc20eed9b297","name":"@charlypoirier/uwebsocket-serve","description":"Static file serving for uWebSockets.js","dist-tags":{"latest":"1.0.9"},"versions":{"1.0.8":{"name":"@charlypoirier/uwebsocket-serve","version":"1.0.8","keywords":["socket","websocket","uwebsocket","uwebsocket.js","serve","file","dir","static","static-serve"],"author":"","license":"ISC","_id":"@charlypoirier/uwebsocket-serve@1.0.8","maintainers":[{"name":"charlypoirier","email":"pro.poiriercharly@gmail.com"}],"homepage":"https://github.com/kolodziejczak-sz/uwebsocket-serve#readme","bugs":{"url":"https://github.com/kolodziejczak-sz/uwebsocket-serve/issues"},"dist":{"shasum":"49b55ea9c162e73b7fdbcd542e1fe21a3ae09765","tarball":"https://registry.npmjs.org/@charlypoirier/uwebsocket-serve/-/uwebsocket-serve-1.0.8.tgz","fileCount":15,"integrity":"sha512-3aOewbxPfQCKcX+IZwKDerx8XX9l/UwSl6BugNgAvhvUejbUi/vQQzrl7LfH8OrhtSUfz9IaXNdGAZWUyroiNg==","signatures":[{"sig":"MEUCIAVyJKw7T3m/j/DDteiqFxFwE3oFRFBswh/RbNhINam0AiEA7XDJDWhPHO3iVhJwazfN7XiIQWny7dcL/ECum5Yx3S4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":102533},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"100904d3059542ad01b57e2b703e75c6a22ccba4","scripts":{"lint":"eslint ./src/**/*.ts","test":"uvu -r esbuild-register","build":"tsc","prepublish":"npm run lint && npm run test && npm run build"},"_npmUser":{"name":"charlypoirier","email":"pro.poiriercharly@gmail.com"},"repository":{"url":"git+https://github.com/kolodziejczak-sz/uwebsocket-serve.git","type":"git"},"_npmVersion":"10.2.4","description":"Static file serving for uWebSockets.js","directories":{"test":"test"},"_nodeVersion":"20.10.0","dependencies":{"mrmime":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"uvu":"^0.5.2","eslint":"^8.4.0","httpie":"^1.1.2","esbuild":"^0.14.2","prettier":"^2.5.1","typescript":"^4.5.2","@types/node":"^16.11.11","uWebSockets.js":"github:uNetworking/uWebSockets.js#v20.4.0","esbuild-register":"^3.2.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","@typescript-eslint/parser":"^5.5.0","@typescript-eslint/eslint-plugin":"^5.5.0"},"peerDependencies":{"uWebSockets.js":"github:uNetworking/uWebSockets.js#v20.4.0"},"_npmOperationalInternal":{"tmp":"tmp/uwebsocket-serve_1.0.8_1708710096460_0.5609386687200195","host":"s3://npm-registry-packages"}},"1.0.9":{"name":"@charlypoirier/uwebsocket-serve","version":"1.0.9","description":"Static file serving for uWebSockets.js","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepublish":"npm run build","test":"uvu -r esbuild-register","lint":"eslint ./src/**/*.ts","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/kolodziejczak-sz/uwebsocket-serve.git"},"keywords":["socket","websocket","uwebsocket","uwebsocket.js","serve","file","dir","static","static-serve"],"author":"","license":"ISC","peerDependencies":{"uWebSockets.js":"github:uNetworking/uWebSockets.js#v20.43.0"},"dependencies":{"mrmime":"^1.0.0"},"devDependencies":{"@types/node":"^16.11.11","@typescript-eslint/eslint-plugin":"^5.5.0","@typescript-eslint/parser":"^5.5.0","esbuild":"^0.14.2","esbuild-register":"^3.2.0","eslint":"^8.4.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","httpie":"^1.1.2","prettier":"^2.5.1","typescript":"^4.5.2","uWebSockets.js":"github:uNetworking/uWebSockets.js#v20.43.0","uvu":"^0.5.2"},"_id":"@charlypoirier/uwebsocket-serve@1.0.9","gitHead":"a1cb08d66eaa99c226fa194a5c994b21c35359c6","bugs":{"url":"https://github.com/kolodziejczak-sz/uwebsocket-serve/issues"},"homepage":"https://github.com/kolodziejczak-sz/uwebsocket-serve#readme","_nodeVersion":"20.10.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-SaX8iIstVkem8BBB7UyoEkEHaJNYrhkazLCbdngp2xIdpInsiKKmCDxne8iWWbGNUWDGcI5MGTqb4lTHS0aXFA==","shasum":"859e03496412e9a78a7b2a61692c6f75e3fbbad9","tarball":"https://registry.npmjs.org/@charlypoirier/uwebsocket-serve/-/uwebsocket-serve-1.0.9.tgz","fileCount":15,"unpackedSize":102451,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCVrkeaWB1gqvBSm8Lw5M6VkLVCu0vmP9ytCS76yIIWYgIhAMwAV5bTnl1Sw8DfXWIWasv1wHrgsuTsVYsTaCfiCzTP"}]},"_npmUser":{"name":"charlypoirier","email":"pro.poiriercharly@gmail.com"},"directories":{},"maintainers":[{"name":"charlypoirier","email":"pro.poiriercharly@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/uwebsocket-serve_1.0.9_1717194092766_0.15825877342311379"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-23T17:41:36.371Z","modified":"2024-05-31T22:21:33.124Z","1.0.8":"2024-02-23T17:41:36.635Z","1.0.9":"2024-05-31T22:21:32.966Z"},"maintainers":[{"name":"charlypoirier","email":"pro.poiriercharly@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/kolodziejczak-sz/uwebsocket-serve.git"},"keywords":["socket","websocket","uwebsocket","uwebsocket.js","serve","file","dir","static","static-serve"],"license":"ISC","homepage":"https://github.com/kolodziejczak-sz/uwebsocket-serve#readme","bugs":{"url":"https://github.com/kolodziejczak-sz/uwebsocket-serve/issues"},"readme":"Static file serving for uWebSockets.js http server.\n\n## Example\n\n```javascript\nimport path from 'path';\nimport { App } from 'uWebSockets.js';\nimport { serveDir } from 'uwebsocket-serve';\n\nconst publicPath = path.resolve(__dirname, '../public');\nconst serveStatic = serveDir(publicPath);\n\nApp().get('/*', serveStatic);\n```\n\n## API\n\n```typescript\nconst serveDir = (directoryPath: string) => (res: HttpResponse, req: HttpRequest) => void\n```\n\n### serveDir(directoryPath: string)\n\nCreate a new middleware function to serve files from within a given root directory. The file to serve will be determined by combining `req.getUrl()` with provided directory.\nWhen a file is not found sending a 404 response.\n\n### Cache\n\nThis module supports the `Last-Modified` HTTP header\n\n### Source\n\nThis library is based on an [example](https://github.com/uNetworking/uWebSockets.js/blob/master/examples/VideoStreamer.js 'uWebSockets.js/examples/VideoStreamer.js') from a uWebSockets.js repository.\n\n### Support\n\n`uwebsocket-serve` is an MIT-licensed open source project. Feel free to fork and contribute.\n","readmeFilename":"README.md"}