Commented

Author: chmoore889

README.md

@@ -1,6 +1,8 @@
 ## Introduction
 This is a library for using a long-lived isolate to encode and decode JSONs.
 
+When in a VM it uses isolates. This package is able to support web by falling back to encoding/decoding without isolates on web. This is so that an application using this package does not have to do that check itself.
+
 ## Usage
 
 A simple usage example:

lib/src/isolate_json.dart

@@ -4,39 +4,42 @@ import 'dart:isolate';
 class JsonIsolate {
   static final JsonIsolate _singleton = JsonIsolate._internal();
 
-  SendPort sendPort;
-  Isolate isolate;
+  SendPort _sendPort;
+  Isolate _isolate;
 
   JsonIsolate._internal();
 
+  /// Singleton for using JSONs in isolates.
   factory JsonIsolate() {
     return _singleton;
   }
 
+  /// Decodes a JSON with an isolate.
   Future<dynamic> decodeJson(String json) async {
-    if (isolate == null) {
+    if (_isolate == null) {
       await _makeIsolate();
     }
 
-    return _sendReceive(sendPort, json, _JsonAction.decode);
+    return _sendReceive(_sendPort, json, _JsonAction.decode);
   }
 
+  /// Encodes a JSON with an isolate.
   Future<dynamic> encodeJson(dynamic toEncode) async {
-    if (isolate == null) {
+    if (_isolate == null) {
       await _makeIsolate();
     }
 
-    return _sendReceive(sendPort, toEncode, _JsonAction.encode);
+    return _sendReceive(_sendPort, toEncode, _JsonAction.encode);
   }
 
   Future<void> _makeIsolate() async {
     final receivePort = ReceivePort();
-    isolate = await Isolate.spawn(
+    _isolate = await Isolate.spawn(
       _isolateDecode,
       receivePort.sendPort,
       debugName: 'json_isolate',
     );
-    sendPort = await receivePort.first;
+    _sendPort = await receivePort.first;
     receivePort.close();
   }
 

lib/src/norm_json.dart

@@ -5,14 +5,21 @@ class JsonIsolate {
 
   JsonIsolate._internal();
 
+  /// Singleton for using JSONs in isolates.
   factory JsonIsolate() {
     return _singleton;
   }
 
+  /// Decodes a JSON without an isolate.
+  ///
+  /// Intended only when using the package on web.
   Future<dynamic> decodeJson(String json) async {
     return jsonDecode(json);
   }
 
+  /// Decodes a JSON without an isolate.
+  ///
+  /// Intended only when using the package on web.
   Future<dynamic> encodeJson(dynamic toEncode) async {
     return jsonEncode(toEncode);
   }

pubspec.yaml

@@ -1,7 +1,7 @@
 name: isolate_json
 description: Library for using a long-lived isolate for JSON encoding and decoding.
 version: 1.0.0
-homepage: https://www.example.com
+homepage: https://github.com/chmoore889/isolate_json
 
 environment:
   sdk: '>=2.10.0 <3.0.0'