eventsource 0.2.2

  • Readme
  • Changelog
  • Installing
  • 73

eventsource #

A library for using EventSource or Server-Sent Events (SSE). Both client and server functionality is provided.

This library implements the interface as described here.

Client usage #

For more advanced usage, see the example/ directory. Creating a new EventSource client is as easy as a single call. The http package is used under the hood, so wherever this package works, this lbirary will also work. Browser usage is slightly different.

EventSource eventSource = await EventSource.connect("http://example.com/events");
// in browsers, you need to pass a http.BrowserClient:
EventSource eventSource = await EventSource.connect("http://example.com/events", 
    client: new http.BrowserClient());

Server usage #

We recommend using shelf_eventsource for serving Server-Sent Events. This library provides an EventSourcePublisher that manages subscriptions, channels, encoding. We refer to documentation in the shelf_eventsource package for more information.

This library also includes a server provider for dart:io's HttpServer in io_server.dart. However, it has some issues with data flushing that are yet to be resolved, so we recommend using shelf instead.

Licensing #

This project is available under the MIT license, as can be found in the LICENSE file.

Changelog #

0.1.0 (2016-11-27) #

  • Initial version

Use this package as a library

1. Depend on it

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


dependencies:
  eventsource: ^0.2.2

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:eventsource/eventsource.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
71
Health:
Code health derived from static analysis. [more]
62
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
97
Overall:
Weighted score of the above. [more]
73
Learn more about scoring.

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

  • Dart: 2.7.0
  • pana: 0.13.4

Health issues and suggestions

Fix lib/publisher.dart. (-28.31 points)

Analysis of lib/publisher.dart failed with 1 error, 9 hints, including:

line 109 col 23: The argument type 'ProxySink' can't be assigned to the parameter type 'Sink

line 30 col 25: Use = to separate a named parameter from its default value.

line 31 col 25: Use = to separate a named parameter from its default value.

line 32 col 25: Use = to separate a named parameter from its default value.

line 34 col 16: Unnecessary new keyword.

Fix lib/eventsource.dart. (-4.41 points)

Analysis of lib/eventsource.dart reported 9 hints, including:

line 48 col 7: Unnecessary new keyword.

line 62 col 24: Unnecessary new keyword.

line 64 col 22: Unnecessary new keyword.

line 70 col 16: Unnecessary new keyword.

line 83 col 19: Unnecessary new keyword.

Fix lib/src/decoder.dart. (-3.93 points)

Analysis of lib/src/decoder.dart reported 8 hints, including:

line 17 col 18: Unnecessary new keyword.

line 19 col 28: Unnecessary new keyword.

line 21 col 26: Unnecessary new keyword.

line 22 col 41: Unnecessary new keyword.

line 27 col 22: Unnecessary new keyword.

Fix additional 3 files with analysis or formatting issues. (-6.45 points)

Additional issues in the following files:

  • lib/io_server.dart (5 hints)
  • lib/src/encoder.dart (5 hints)
  • lib/src/event_cache.dart (3 hints)

Maintenance suggestions

The package description is too short. (-3 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and eventsource.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.0.0 <3.0.0
collection >=1.4.1 <2.0.0 1.14.12
http >=0.11.0 <0.13.0 0.12.0+4
http_parser >=2.2.0 <4.0.0 3.1.3
logging >=0.11.0 <0.12.0 0.11.4
sync >=0.1.0 <0.3.0 0.2.0
Transitive dependencies
async 2.4.0
charcode 1.1.2
meta 1.1.8
path 1.6.4
pedantic 1.9.0
source_span 1.6.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
test >=0.12.0 <2.0.0