jaguar_static_file 0.5.5

  • README.md
  • Installing
  • Versions
  • 47

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();
}

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

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • tool failures on Feb 24, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
12 / 100
Health:
Code health derived from static analysis. [more]
86 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
76 / 100
Overall score:
Weighted score of the above. [more]
47

Platforms

Detected platforms: other

Primary library: package:jaguar_static_file/jaguar_static_file.dart with components: io, mirrors.

Suggestions

  • Fix lib/src/static_file.dart.

    Strong-mode analysis of lib/src/static_file.dart failed with the following error:

    line: 25 col: 63
    The name 'JaguarFile' isn't a type so it can't be used as a type argument.

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • Fix issues reported by dartanalyzer.

    dartanalyzer reported 1 error(s) and 0 warning(s).

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use jaguar_static_file.dart.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <2.0.0
jaguar ^0.6.7 0.6.29 1.3.4
Transitive dependencies
args 1.2.0 1.4.1
charcode 1.1.1
collection 1.14.5
convert 2.0.1
crypto 2.0.2+1
dice 1.7.0
http_server 0.9.7
intl 0.15.2
logging 0.11.3+1
meta 1.1.2
mime 0.9.6
mustache 0.2.5+1 1.0.0
quiver_hashcode 1.0.0
source_span 1.4.0
stack_trace 1.9.2
string_scanner 1.0.2
typed_data 1.1.5
yaml 2.1.13
Dev dependencies
http >=0.11.3+13 <0.12.0
path >=1.4.1 <1.5.0 1.5.1
test