Changelog

This file contains highlights of what changes on each version of the Node.js Interop for Dart library.

Version 0.9.0

• Breaking change: starting to use and support the Dart 2 SDK.
• Added a user guide based on MkDocs.
• Added the Platform.operatingSystemVersion property.
• Added the throwDeprecation and traceDeprecation properties to the Process class.
• Added the ProcessSignal class.
• Updated the dependencies.

Version 0.8.0

• Breaking change: removed most classes of the nodejs_interop.js library (JSObject, Json, Reflect, TypedArray and Uint8Array).
• Breaking change: removed the instance methods of the Buffer class, as this class is casted to the Uint8List class by the Dart runtime.
• Breaking change: renamed the convertToFuture() function to asFuture().
• Breaking change: renamed the convertToStream() function to asStream().
• Breaking change: renamed the DeleteOptions class to DelOptions.
• Breaking change: renamed the NodeProcess class to Process.
• Breaking change: renamed the NodeRelease class to Release.
• Breaking change: renamed the ReadStream class to FSReadStream.
• Breaking change: renamed the WriteStream class to FSWriteStream.
• Breaking change: the FileStat.fromStats() constructor is now private.
• Added the tty module.
• Added utility functions for converting functions following the Node.js callback style to a Future (e.g. fn1cb0ToFuture(), fn3cb2ToFuture(), ...).
• Added the RandomAccessFile and SystemEncoding classes.
• Added the asPromise(), deleteProperty() and getProperties() functions.
• Added the Promise.JS$catch() method.
• Added new unit tests.
• Fixed the implementation of the FileStat class.
• The nodejs_interop.js library exports the functions from the dart:js_util library.
• Updated the Node.js dependencies.

Version 0.7.0

• Breaking change: renamed the convertToDart() function to dartify().
• Breaking change: renamed the ReaddirEnhancedModule class to ReaddirModule.
• Breaking change: the nodejs_interop.io, nodejs_interop.js, nodejs_interop.node and nodejs_interop.npm libraries are no longer exported individually.
• Added the exit() and sleep() functions.
• Added the exitCode and pid properties.
• Added the Buffer.BYTES_PER_ELEMENT static property.
• Added the InternetAddress, InternetAddressType, JSObject, NetworkInterface, ProcessInfo and Reflect classes.
• Added the minify option to the Pub transformer.
• Added new methods to the Console and Uint8Array classes.
• Added new unit tests.
• Fixed the implementation of the dns module.

Version 0.6.0

• Breaking change: renamed the Path class to PathObject.
• Breaking change: renamed the ReadOptions class to ReadFileOptions.
• Breaking change: renamed the ResolveOptions class to ResolveFunctionOptions.
• Breaking change: renamed the WarningOptions class to EmitWarningOptions.
• Breaking change: renamed the WriteOptions class to WriteFileOptions.
• Added setters to properties of all @anonymous classes.
• Added the dns module.
• Added the querystring module.
• Added the string_decoder module.
• Added the url module.
• Added a partial implementation of the process manager API.
• Added a Pub transformer.
• Finished the implementation of the util module.

Version 0.5.0

• Breaking change: removed the FileStat.toJson() method.
• Breaking change: renamed the Process class to NodeProcess.
• Added the child_process module.
• Added the cluster module.
• Added the stream module.
• Added the vm module.
• Added the BufferEncoding.fromEncoding() method.
• Added the current and systemTemp static properties to the Directory class.
• Finished the implementation of the fs module.

Version 0.4.0

• Breaking change: renamed the Js prefix to JS for JavaScript errors.
• Breaking change: renamed the NodejsPlatform class to Platform.
• Added bindings for a predefined set of npm packages.
• Added the buffer module.
• Added the console module.
• Added the convertToStream() and loadLibrary() functions.
• Added the Json, Module and Writable classes.
• Added a partial implementation of the fs module.
• Added a partial implementation of the util module.
• Added a partial implementation of the file system API.
• Finished the implementation of the Process class.
• Finished the implementation of the require() function.
• Splitted the library in modules: io, js, node and npm.

Version 0.3.0

• Added the os module.
• Added the convertToDart() and convertToFuture() functions.
• Added the CpuUsage, NodejsPlatform and Promise classes.
• Added a partial implementation of the Process class.

Version 0.2.0

• Breaking change: renamed the PathObject class to Path.
• Added the assert module.
• Added the errors module.
• Added the events module.

Version 0.1.0

• Initial release: provides the require() function and the path module.

Use this package as a library

1. Depend on it

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

dependencies:
  nodejs_interop: "^0.9.0"

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:nodejs_interop/io.dart';

      import 'package:nodejs_interop/js.dart';

      import 'package:nodejs_interop/node.dart';

      import 'package:nodejs_interop/npm.dart';

      import 'package:nodejs_interop/transformer.dart';
  

Analysis

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

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

Scores

Platforms

Detected platforms: web, other

Platform components identified in package: build, io, js.

Suggestions

• Fix analysis and formatting issues.

  Analysis or formatting checks reported 101 hints.

  Run dartfmt to format lib/io.dart.

  Run dartfmt to format lib/src/io/file/directory.dart.

  Similar analysis of the following files failed:

  • lib/src/io/file/file.dart (hint)
  • lib/src/io/file/file_stat.dart (hint)
  • lib/src/io/file/file_system.dart (hint)
  • lib/src/io/file/file_system_entity.dart (hint)
  • lib/src/io/file/file_system_events.dart (hint)
  • lib/src/io/file/link.dart (hint)
  • lib/src/io/file/random_access_file.dart (hint)
  • lib/src/io/platform/platform.dart (hint)
  • lib/src/io/process/process.dart (hint)
  • lib/src/io/process/process_info.dart (hint)
  • lib/src/io/process/process_manager.dart (hint)
  • lib/src/io/process/process_signal.dart (hint)
  • lib/src/io/socket/internet_address.dart (hint)
  • lib/src/io/socket/network_interface.dart (hint)
  • lib/src/io/string_transformer/system_encoding.dart (hint)
  • lib/src/js/error.dart (hint)
  • lib/src/js/functions.dart (hint)
  • lib/src/js/promise.dart (hint)
  • lib/src/node/assert/assert_module.dart (hint)
  • lib/src/node/assert/assertion_error.dart (hint)
  • lib/src/node/buffer/buffer.dart (hint)
  • lib/src/node/buffer/buffer_constants.dart (hint)
  • lib/src/node/buffer/buffer_encoding.dart (hint)
  • lib/src/node/buffer/buffer_module.dart (hint)
  • lib/src/node/child_process/child_process.dart (hint)
  • lib/src/node/child_process/child_process_module.dart (hint)
  • lib/src/node/cluster/cluster_module.dart (hint)
  • lib/src/node/cluster/worker.dart (hint)
  • lib/src/node/console/console.dart (hint)
  • lib/src/node/dns/dns_module.dart (hint)
  • lib/src/node/dns/dns_record.dart (hint)
  • lib/src/node/dns/ip_address.dart (hint)
  • lib/src/node/dns/resolver.dart (hint)
  • lib/src/node/dns/resource_record_type.dart (hint)
  • lib/src/node/errors/system_error.dart (hint)
  • lib/src/node/events/event_emitter.dart (hint)
  • lib/src/node/fs/fs_constants.dart (hint)
  • lib/src/node/fs/fs_module.dart (hint)
  • lib/src/node/fs/fs_watcher.dart (hint)
  • lib/src/node/fs/options.dart (hint)
  • lib/src/node/fs/stats.dart (hint)
  • lib/src/node/fs/stream.dart (hint)
  • lib/src/node/functions.dart (hint)
  • lib/src/node/http/http_module.dart (hint)
  • lib/src/node/http/server.dart (hint)
  • lib/src/node/modules/module.dart (hint)
  • lib/src/node/modules/module_module.dart (hint)
  • lib/src/node/modules/require.dart (hint)
  • lib/src/node/net/net_module.dart (hint)
  • lib/src/node/net/server.dart (hint)
  • lib/src/node/net/socket.dart (hint)
  • lib/src/node/os/cpu.dart (hint)
  • lib/src/node/os/network_address.dart (hint)
  • lib/src/node/os/os_constants.dart (hint)
  • lib/src/node/os/os_module.dart (hint)
  • lib/src/node/os/user_info.dart (hint)
  • lib/src/node/path/path_module.dart (hint)
  • lib/src/node/path/path_object.dart (hint)
  • lib/src/node/process/process.dart (hint)
  • lib/src/node/querystring/query_string_module.dart (hint)
  • lib/src/node/stream/duplex.dart (hint)
  • lib/src/node/stream/readable.dart (hint)
  • lib/src/node/stream/transform.dart (hint)
  • lib/src/node/stream/writable.dart (hint)
  • lib/src/node/string_decoder/string_decoder.dart (hint)
  • lib/src/node/tty/stream.dart (hint)
  • lib/src/node/tty/tty_module.dart (hint)
  • lib/src/node/url/url.dart (hint)
  • lib/src/node/url/url_module.dart (hint)
  • lib/src/node/url/url_object.dart (hint)
  • lib/src/node/util/inspect_function.dart (hint)
  • lib/src/node/util/promisify_function.dart (hint)
  • lib/src/node/util/text_decoder.dart (hint)
  • lib/src/node/util/text_encoder.dart (hint)
  • lib/src/node/util/util_module.dart (hint)
  • lib/src/node/vm/script.dart (hint)
  • lib/src/node/vm/vm_module.dart (hint)
  • lib/src/npm/del.dart (hint)
  • lib/src/npm/ipaddr.dart (hint)
  • lib/src/npm/make_dir.dart (hint)
  • lib/src/npm/os_locale.dart (hint)
  • lib/src/npm/readdir_enhanced.dart (hint)
  • lib/src/npm/supports_color.dart (hint)
  • lib/transformer.dart (hint)

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

  Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use nodejs_interop.dart.

Dependencies