Dart pub
This library exposes Node I/O functionality in dart:io way. It wraps Node.js
I/O modules (like fs and http) and implements them using abstractions
provided by dart:io (like File, Directory or HttpServer).
If you are looking for direct access to Node.js API see node_interop package.
A basic example of accessing file system:
import 'package:node_io/node_io.dart';
void main() {
print(Directory.current);
print("Current directory exists: ${Directory.current.existsSync()}");
print('Current directory contents: ');
Directory.current.list().listen(print);
}
Add build_node_compilers and build_runner to dev_dependencies section
in pubspec.yaml of your project:
dev_dependencies:
build_runner: # needed to run the build
build_node_compilers:
Add build.yaml file to the root of your project:
targets:
$default:
sources:
- "node/**"
- "test/**" # Include this if you want to compile tests.
- "example/**" # Include this if you want to compile examples.
By convention all Dart files which declare main function go in node/ folder.
To build your project run following:
pub run build_runner build --output=build/
Detailed instructions can be found in build_node_compilers package docs.
Please file feature requests and bugs at the issue tracker.
NodeHttpRequest and NodeHttpResponse are now available in public interface.First stable release of this library which implements subset of dart:io interfaces,
including File System objects, HttpServer, Platform and other common classes.
Not all dart:io interfaces are covered yet. Feel free to file an issue on Github if you need
a specific class implemented in node_io.
Directory, File, RandomAccessFile, Link.STATUS.md which reflects coverage of already implemented or exported dart:io APIs.NodeHttpResponse.redirect failing to convert Uri to string.Directory.delete.Directory.list.Directory and File.File.create, File.delete, File.readAsString, File.rename,
File.writeAsBytes, File.writeAsString.File.open, File.stat, File.statSync.NodeIOSink.HttpHeaders.set.InternetAddress.example/node_io.dart
import 'package:node_io/node_io.dart';
void main() {
print(Directory.current);
print("Current directory exists: ${Directory.current.existsSync()}");
print('Current directory contents: ');
Directory.current.list().listen(print);
}
Add this to your package's pubspec.yaml file:
dependencies:
node_io: ^1.0.1+2
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.
Now in your Dart code, you can use:
import 'package:node_io/node_io.dart';
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
62
|
|
Health:
Code health derived from static analysis.
[more]
|
72
|
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
80
|
|
Overall:
Weighted score of the above.
[more]
|
69
|
We analyzed this package on Jul 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: web, other
Primary library:
package:node_io/node_io.dartwith components:js,io.
Fix lib/src/file.dart. (-12.22 points)
Analysis of lib/src/file.dart reported 26 hints, including:
line 13 col 44: Use lowercase_with_underscores when specifying a library prefix.
line 168 col 38: Use = to separate a named parameter from its default value.
line 191 col 34: Use = to separate a named parameter from its default value.
line 197 col 53: Use = to separate a named parameter from its default value.
line 217 col 34: Use = to separate a named parameter from its default value.
Fix lib/src/directory.dart. (-7.71 points)
Analysis of lib/src/directory.dart reported 16 hints, including:
line 11 col 44: Use lowercase_with_underscores when specifying a library prefix.
line 99 col 10: Avoid return types on setters.
line 127 col 53: Use = to separate a named parameter from its default value.
line 129 col 7: DO use curly braces for all flow control structures.
line 147 col 34: Use = to separate a named parameter from its default value.
Fix lib/src/http_server.dart. (-5.84 points)
Analysis of lib/src/http_server.dart reported 12 hints, including:
line 113 col 23: Use = to separate a named parameter from its default value.
line 113 col 39: Use = to separate a named parameter from its default value.
line 113 col 59: Use = to separate a named parameter from its default value.
line 180 col 19: Use = to separate a named parameter from its default value.
line 180 col 35: Use = to separate a named parameter from its default value.
Fix additional 5 files with analysis or formatting issues. (-5.97 points)
Additional issues in the following files:
lib/src/link.dart (5 hints)lib/src/file_system_entity.dart (3 hints)lib/src/http_headers.dart (2 hints)lib/src/internet_address.dart (1 hint)lib/src/streams.dart (1 hint)The package description is too short. (-20 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.
| Package | Constraint | Resolved | Available |
|---|---|---|---|
| Direct dependencies | |||
| Dart SDK | >=2.1.0 <3.0.0 | ||
| node_interop | ^1.0.1 | 1.0.3 | |
| path | ^1.6.2 | 1.6.2 | |
| Dev dependencies | |||
| build_node_compilers | ^0.2.0 | ||
| build_runner | ^1.0.0 | ||
| build_test | any | ||
| js | ^0.6.0 | 0.6.1+1 | |
| test | ^1.0.0 | ||