Skip to main content

dox_websocket 1.0.0 copy "dox_websocket: ^1.0.0" to clipboard
dox_websocket: ^1.0.0 copied to clipboard

Websocket library for dox framework.

120/ 160
pub points
311
downloads

We analyzed this package 2 days ago, and awarded it 120 pub points (of a possible 160):

Failed report section
Follow Dart file conventions
20 / 30trigger folding of the section

Failed check 0/10 points: Provide a valid pubspec.yaml

The package description is too short.

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

Failed to verify repository URL.

Repository has no matching pubspec.yaml with name: dox_websocket.

Please provide a valid repository URL in pubspec.yaml, such that:

  • repository can be cloned,
  • a clone of the repository contains a pubspec.yaml, which:,
    • contains name: dox_websocket,
    • contains a version property, and,
    • does not contain a publish_to property.

Passed check 5/5 points: Provide a valid README.md

Passed check 5/5 points: Provide a valid CHANGELOG.md

Passed check 10/10 points: Use an OSI-approved license

Detected license: MIT.

Partially passed report section
Provide documentation
10 / 20trigger folding of the section

Partially passed check 0/10 points: 20% or more of the public API has dartdoc comments

6 out of 41 API elements (14.6 %) have documentation comments.

Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Document at least 20% of the public API elements.

To highlight public API members missing documentation consider enabling the public_member_api_docs lint.

Some symbols that are missing documentation: dox_websocket, dox_websocket.WebsocketAdapterInterface, dox_websocket.WebsocketAdapterInterface.WebsocketAdapterInterface.new, dox_websocket.WebsocketAdapterInterface.emit, dox_websocket.WebsocketEmitEvent.

Passed check 10/10 points: Package has an example

Passed report section
Platform support
20 / 20trigger folding of the section

Passed check 20/20 points: Supports 5 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

  • ✓ Android

  • ✓ iOS

  • ✓ Windows

  • ✓ Linux

  • ✓ macOS

These platforms are not supported:

Package not compatible with platform Web

Because:

  • package:dox_websocket/dox_websocket.dart that imports:
  • package:dox_websocket/src/websocket_info.dart that imports:
  • dart:io
Partially passed report section
Pass static analysis
40 / 50trigger folding of the section

Partially passed check 40/50 points: code has no errors, warnings, lints, or formatting issues

Found 5 issues. Showing the first 2:

INFO: Missing type annotation.

lib/src/adapters/websocket_adapter.dart:4:3

  ╷
4 │   emit(WebsocketEmitEvent event);
  │   ^^^^
  ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/adapters/websocket_adapter.dart

INFO: Missing type annotation.

lib/src/websocket.dart:27:3

   ╷
27 │   _initialize() {
   │   ^^^^^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/websocket.dart

Failed report section
Support up-to-date dependencies
30 / 40trigger folding of the section

Failed check 0/10 points: All of the package dependencies are supported in the latest version

Package Constraint Compatible Latest Notes
dox_annotation ^1.0.5 1.0.5 3.0.0
ioredis ^1.0.2 1.0.3 3.0.1
uuid ^3.0.6 3.0.7 4.6.0
Transitive dependencies
Package Constraint Compatible Latest Notes
crypto - 3.0.8 3.0.8

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

Found 3 issues. Showing the first 2:

The constraint `^1.0.5` on dox_annotation does not support the stable version `3.0.0`, that was published 1 days ago.

When dox_annotation is 30 days old, this package will no longer be awarded points in this category.

Try running dart pub upgrade --major-versions dox_annotation to update the constraint.

The constraint `^1.0.2` on ioredis does not support the stable version `3.0.0`, that was published 1 days ago.

When ioredis is 30 days old, this package will no longer be awarded points in this category.

Try running dart pub upgrade --major-versions ioredis to update the constraint.

Passed check 10/10 points: Package supports latest stable Dart and Flutter SDKs

Passed check 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.23.19, Dart 3.13.5.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:
1
likes
120
points
311
downloads

Documentation

API reference

Publisher

verified publisherdartondox.dev

Weekly Downloads

Websocket library for dox framework.

License

MIT (license)

Dependencies

dox_annotation, ioredis, uuid

More

Packages that depend on dox_websocket