Angel3 Static Files Handler
This library provides a virtual directory to serve static files such as html, css and js for Angel3 framework. It can also handle Range requests, making it suitable for media streaming, i.e. music, video, etc.*
Installation
In pubspec.yaml:
dependencies:
angel3_static: ^10.0.0
Usage
To serve files from a directory, you need to create a VirtualDirectory. Keep in mind that angel3_static uses package:file instead of dart:io.
import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel3_framework/http.dart';
import 'package:angel3_static/angel3_static.dart';
import 'package:file/local.dart';
void main() async {
var app = Angel();
var fs = const LocalFileSystem();
// Normal static server
var vDir = VirtualDirectory(app, fs, source: fs.directory('./public'));
// Or, send Cache-Control, ETag, etc. as well
vDir = CachingVirtualDirectory(app, fs, source: fs.directory('./public'));
// Mount the VirtualDirectory's request handler
app.fallback(vDir.handleRequest);
// Start your server!!!
await AngelHttp(app).startServer();
}
Push State
VirtualDirectory also exposes a pushState method that returns a request handler that serves the file at a given path as a fallback, unless the user is requesting that file. This can be very useful for SPA's.
// Create VirtualDirectory as well
var vDir = CachingVirtualDirectory(...);
// Mount it
app.fallback(vDir.handleRequest);
// Fallback to index.html on 404
app.fallback(vDir.pushState('index.html'));
Options
The VirtualDirectory API accepts a few named parameters:
- source: A
Directorycontaining the files to be served. If left null, then Angel3 will serve either fromweb(in development) orbuild/web(in production), depending on yourANGEL_ENV. - indexFileNames: A
List<String>of filenames that should be served as index pages. Default is['index.html']. - publicPath: To serve index files, you need to specify the virtual path under which angel3_static is serving your files. If you are not serving static files at the site root, please include this.
- callback: Runs before sending a file to a client. Use this to set headers, etc. If it returns anything other than
nullortrue, then the callback's result will be sent to the user, instead of the file contents. - followLinksOutsideSource: If
true(default:false), a symbolic link insourceto a file or directory outside of it is followed. Otherwise such a path is not served, as if it did not exist.
Migrating from 9.x to 10.0.0
The breaking changes of each release are listed in the CHANGELOG. Those of 10.0.0 that may need changes in an app:
- ETags are quoted, and made of the file's modification time and size (
"18f3a2b4c10-a"), as RFC 9110 requires, so the ETags clients kept from 9.x no longer match, and the files are sent again once. - Symbolic links: a symbolic link in
sourceto a path outside it is not served, unlessfollowLinksOutsideSourceistrue.