shelf_flutter_asset

A simple handler for the Shelf ecosystem to serve files from Flutter assets.

Features

• Serves files from Flutter assets
• Support for default documents (like index.html)
• Content type detection
• Optional caching support with customizable max-age
• Support for HTTP range requests
• Support for conditional requests with If-Modified-Since

Usage

Bind as root handler:

import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_flutter_asset/shelf_flutter_asset.dart';

void main() {
  var assetHandler = createAssetHandler(defaultDocument: 'index.html');

  io.serve(assetHandler, 'localhost', 8080);
}

Bind with shelf_router:

import 'package:shelf_router/shelf_router.dart';
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart' as io;

void main() {
  var app = Router();
  final assetHandler = createAssetHandler();

  app.get('/hello', (Request request) {
    return Response.ok('hello-world');
  });

  app.get('/assets/<ignored|.*>', (Request request) {
    return assetHandler(request.change(path: 'assets'));
  });

  io.serve(app, 'localhost', 8080);
}

Bind with shelf_router and custom root path:

import 'package:shelf_router/shelf_router.dart';
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart' as io;

void main() {
  var app = Router();
  final assetHandler = createAssetHandler(rootPath: 'assets/html');

  app.get('/hello', (Request request) {
    return Response.ok('hello-world');
  });

  app.get('/assets/<ignored|.*>', (Request request) {
    return assetHandler(request.change(path: 'assets/html'));
  });

  io.serve(app, 'localhost', 8080);
}

Advanced Usage

Caching

Enable browser caching for better performance:

import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_flutter_asset/shelf_flutter_asset.dart';

void main() {
  var assetHandler = createAssetHandler(
    defaultDocument: 'index.html',
    enableCaching: true,    // Enable caching
    maxAge: 3600,           // Cache for 1 hour (in seconds)
  );

  io.serve(assetHandler, 'localhost', 8080);
}