https://github.com/plugfox/isolation
Isolate helper for flutter and dart.
https://github.com/plugfox/isolation
Last synced: 9 months ago
JSON representation
Isolate helper for flutter and dart.
- Host: GitHub
- URL: https://github.com/plugfox/isolation
- Owner: PlugFox
- License: mit
- Created: 2022-08-07T18:37:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-27T06:47:23.000Z (over 3 years ago)
- Last Synced: 2025-03-18T18:06:07.229Z (about 1 year ago)
- Language: Dart
- Size: 33.2 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Isolation
[](https://pub.dev/packages/isolation)
[](https://github.com/PlugFox/isolation/actions/workflows/checkout.yml)
[](https://codecov.io/gh/PlugFox/isolation)
[](https://opensource.org/licenses/MIT)
[](https://dart-lang.github.io/linter/lints/)
---
# Overview
The package simplifies the creation and interaction between isolates.
It encapsulates the entire boilerplate, leaving the developer with only transport with an API that looks like two stream controllers.
The package also helps to preserve typing and pass exceptions between isolates.
# Usage
## JSON parser
```dart
import 'dart:async';
import 'dart:convert' show jsonDecode;
import 'package:isolation/isolation.dart';
typedef JsonMap = Map;
/// Main isolate
void main() => Future(() async {
// Create a new isolate controller
final controller = IsolateController(
_parser, // Isolate function
lazy: true, // The isolate will not be created until the first message
)
// Add few messages to the isolate:
..add('{}')
..add('{"field": 123}')
..add('{"fizz": "buzz", "value": 2, "undefined": null}');
// Listen messages from slave isolate
await controller.stream.take(3).forEach(print);
// Gracefully closing connection and finally kill slave isolate
await controller.close(force: false);
});
/// Slave isolate for parsing JSON, where you can subscribe to the stream
/// from the main isolate and send the result back through the controller.
Future _parser(IsolateController controller) =>
controller.stream.forEach((json) {
final result = jsonDecode(json) as Object?;
(result is JsonMap)
? controller.add(result)
: controller.addError(const FormatException('Invalid JSON'));
});
```
## Installation
Add the following to your `pubspec.yaml` file to be able to do code generation:
```yaml
dependencies:
isolation: any
```
Then run:
```shell
dart pub get
```
or
```shell
flutter pub get
```
## Coverage
[](https://codecov.io/gh/PlugFox/isolation/branch/master)
## Changelog
Refer to the [Changelog](https://github.com/plugfox/isolation/blob/master/CHANGELOG.md) to get all release notes.
## Maintainers
[Plague Fox](https://plugfox.dev)
## License
[MIT](https://github.com/plugfox/isolation/blob/master/LICENSE)