shelf_static 0.2.7+1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 95

shelf_static is a Handler for the Dart shelf package.

Build Status

Example

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

void main() {
  var handler = createStaticHandler('example/files', 
      defaultDocument: 'index.html');

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

0.2.7+1

  • Updated SDK version to 2.0.0-dev.17.0

0.2.7

  • Require at least Dart SDK 1.24.0.
  • Other internal changes e.g. removing dep on scheduled_test.

0.2.6

  • Add a createFileHandler() function that serves a single static file.

0.2.5

  • Add an optional contentTypeResolver argument to createStaticHandler.

0.2.4

  • Add support for "sniffing" the content of the file for the content-type via an optional useHeaderBytesForContentType argument on createStaticHandler.

0.2.3+4

  • Support http_parser 3.0.0.

0.2.3+3

  • Support shelf 0.7.0.

0.2.3+2

  • Support http_parser 2.0.0.

0.2.3+1

  • Support http_parser 1.0.0.

0.2.3

  • Added listDirectories argument to createStaticHandler.

0.2.2

  • Bumped up minimum SDK to 1.7.0.

  • Added support for shelf 0.6.0.

0.2.1

  • Removed Uri format checks now that the core libraries is more strict.

0.2.0

  • Removed deprecated getHandler.

  • Send correct mime type for default document.

0.1.4+6

  • Updated development dependencies.

0.1.4+5

  • Handle differences in resolution between DateTime and HTTP date format.

0.1.4+4

  • Using latest shelf. Cleaned up test code by using new features.

0.1.4

  • Added named (optional) defaultDocument argument to createStaticHandler.

0.1.3

  • createStaticHandler added serveFilesOutsidePath optional parameter.

0.1.2

  • The preferred top-level method is now createStaticHandler. getHandler is deprecated.
  • Set content-type header if the mime type of the requested file can be determined from the file extension.
  • Respond with 304-Not modified against IF-MODIFIED-SINCE request header.
  • Better error when provided a non-existent fileSystemPath.
  • Added example/example_server.dart.

0.1.1+1

  • Removed work around for issue.

0.1.1

  • Correctly handle requests when not hosted at the root of a site.
  • Send last-modified header.
  • Work around known issue with HTTP date formatting.

Use this package as a library

1. Depend on it

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


dependencies:
  shelf_static: "^0.2.7+1"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

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

3. Import it

Now in your Dart code, you can use:


      import 'package:shelf_static/shelf_static.dart';
  
Version Uploaded Documentation Archive
0.2.7+1 May 22, 2018 Go to the documentation of shelf_static 0.2.7+1 Download shelf_static 0.2.7+1 archive
0.2.7 Jan 4, 2018 Go to the documentation of shelf_static 0.2.7 Download shelf_static 0.2.7 archive
0.2.6 Oct 18, 2017 Go to the documentation of shelf_static 0.2.6 Download shelf_static 0.2.6 archive
0.2.5 Jul 7, 2017 Go to the documentation of shelf_static 0.2.5 Download shelf_static 0.2.5 archive
0.2.4 Jul 6, 2016 Go to the documentation of shelf_static 0.2.4 Download shelf_static 0.2.4 archive
0.2.3+4 May 5, 2016 Go to the documentation of shelf_static 0.2.3+4 Download shelf_static 0.2.3+4 archive
0.2.3+3 Feb 2, 2016 Go to the documentation of shelf_static 0.2.3+3 Download shelf_static 0.2.3+3 archive
0.2.3+2 Dec 14, 2015 Go to the documentation of shelf_static 0.2.3+2 Download shelf_static 0.2.3+2 archive
0.2.3+1 Aug 26, 2015 Go to the documentation of shelf_static 0.2.3+1 Download shelf_static 0.2.3+1 archive
0.2.3 Jul 31, 2015 Go to the documentation of shelf_static 0.2.3 Download shelf_static 0.2.3 archive

All 26 versions...

Analysis

We analyzed this package on Jun 19, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
91 / 100
Health:
Code health derived from static analysis. [more]
98 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
95
Learn more about scoring.

Platforms

Detected platforms: Flutter, other

Primary library: package:shelf_static/shelf_static.dart with components: io, isolate.

Suggestions

  • 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.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 4 hints.

    Strong-mode analysis of lib/src/directory_listing.dart gave the following hint:

    line: 98 col: 49
    'CONTENT_TYPE' is deprecated and shouldn't be used.

    Strong-mode analysis of lib/src/static_handler.dart gave the following hint:

    line: 192 col: 17
    'CONTENT_LENGTH' is deprecated and shouldn't be used.

  • 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 shelf_static.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.55.0 <2.0.0
convert >=1.0.0 <3.0.0 2.0.1
http_parser >=0.0.2+2 <4.0.0 3.1.2
mime >=0.9.0 <0.10.0 0.9.6+1
path >=1.1.0 <2.0.0 1.6.1
shelf >=0.5.7 <0.8.0 0.7.3+1
Transitive dependencies
async 2.0.7
charcode 1.1.1
collection 1.14.10
source_span 1.4.0
stack_trace 1.9.2
stream_channel 1.6.7+1
string_scanner 1.0.2
typed_data 1.1.5
Dev dependencies
args ^1.0.0
test >=0.12.0 <0.13.0
test_descriptor ^1.0.0