jaguar_static_file 0.5.5

  • README.md
  • Installing
  • Versions
  • 0

jaguar_static_file

Provides two ways to serve static files

  1. StaticFileHandler : RequestHandler based
  2. StaticFile : Interceptor based

StaticFileHandler

StaticFileHandler is RequestHandler based. It can be directly added to Jaguar server using addApi method or included in an Api using IncludeApi annotation.

Usage

Future main() async {
  final server = new Jaguar();
  server.addApi(
      new StaticFileHandler('/public/*', new Directory('./example/static/')));
  await server.serve();
}

StaticFile

StaticFile is an interceptor that substituted JaguarFile in response with actual content of the file JaguarFile (JaguarFile) points to.

Usage

@Api()
class MyApi extends _$MyApi {
  @Get(path: '/file')
  @WrapOne(#staticFile)
  JaguarFile getFile(Context ctx) =>
      new JaguarFile(Directory.current.path + "/static/file.css");

  @Get(path: '/static/:filename*')
  @WrapOne(#staticFile)
  JaguarFile getDir(Context ctx) => new JaguarFile(
      Directory.current.path + '/static/' + ctx.pathParams['filename']);

  StaticFile staticFile(Context ctx) => new StaticFile();
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  jaguar_static_file: ^0.5.5

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:jaguar_static_file/jaguar_static_file.dart';
  
Version Uploaded Documentation Archive
0.5.5 Oct 15, 2017 Go to the documentation of jaguar_static_file 0.5.5 Download jaguar_static_file 0.5.5 archive
0.5.4 Oct 15, 2017 Go to the documentation of jaguar_static_file 0.5.4 Download jaguar_static_file 0.5.4 archive
0.5.3 Jul 21, 2017 Go to the documentation of jaguar_static_file 0.5.3 Download jaguar_static_file 0.5.3 archive
0.5.2 Jul 10, 2017 Go to the documentation of jaguar_static_file 0.5.2 Download jaguar_static_file 0.5.2 archive
0.5.1 Jun 9, 2017 Go to the documentation of jaguar_static_file 0.5.1 Download jaguar_static_file 0.5.1 archive
0.5.0 Jun 6, 2017 Go to the documentation of jaguar_static_file 0.5.0 Download jaguar_static_file 0.5.0 archive
0.4.0 Feb 19, 2017 Go to the documentation of jaguar_static_file 0.4.0 Download jaguar_static_file 0.4.0 archive
0.3.0 Feb 6, 2017 Go to the documentation of jaguar_static_file 0.3.0 Download jaguar_static_file 0.3.0 archive
0.2.1 Jan 24, 2017 Go to the documentation of jaguar_static_file 0.2.1 Download jaguar_static_file 0.2.1 archive
0.2.0 Jan 21, 2017 Go to the documentation of jaguar_static_file 0.2.0 Download jaguar_static_file 0.2.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
--
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
--
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Maintenance issues and suggestions

Running dartdoc failed. (-10 points)

Make sure dartdoc runs without any issues.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <2.0.0