@wooksjs/http-static 0.1.0

package/README.md

@@ -0,0 +1,77 @@
+# Wooks Serve File
+
+**!!! This is work-in-progress library, breaking changes are expected !!!**
+
+<p align="center">
+<img src="../../logo.png" width="128px"><br>
+<a  href="https://github.com/prostojs/wooks/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" />
+</a>
+</p>
+
+
+Wooks Serve File is composable static file server for [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http).
+
+`serveFile` returns a readable stream and prepares all the neccessary response headers (like content-length, content-type etc).
+
+- ✅ returns a readable stream
+- ✅ prepares all the neccessary response headers (like content-length, content-type etc)
+- ✅ can handle etag
+- ✅ can handle ranges
+
+## Install
+
+`npm install @wooksjs/http-static`
+
+## Usage
+
+
+```js
+import { serveFile } from '@wooksjs/http-static'
+// ...
+serveFile(filePath, options)
+```
+
+**serveFile options**
+```ts
+{
+    // Any header to add
+    headers?: Record<string, string>,
+
+    // Cache-Control header
+    cacheControl?: TCacheControl,
+
+    // Expires header
+    expires?: Date | string | number,
+
+    // when true a header "Pragma: no-cache" will be added
+    pragmaNoCache?: boolean,
+
+    // the base directory path
+    baseDir?: string,
+
+    // default extension will be added to the filePath
+    defaultExt?: string,
+
+    // when true lists files in directory
+    listDirectory?: boolean,
+    
+    // put 'index.html'
+    // to automatically serve it from the folder    
+    index?: string,           
+}
+```
+
+### Built-in file server example:
+
+```js
+import { useRouteParams } from 'wooks'
+import { serveFile } from '@wooksjs/http-static'
+app.get('static/*', () => {
+    const { get } = useRouteParams()
+    return serveFile(get('*'), { cacheControl: { maxAge: '10m' } })
+})
+```
+
+`cacheControl` here is the same object as used in `useSetCacheControl().setCacheControl({ ... })` from `@wooksjs/composables`
+