Fix typo. (#61)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 61ed91e..d3fbd4e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 6.0.0
+
+* Fix typo in public API.
+* Add assersion for negative delay between snapshots.
+
# 5.0.0
* Migrate from auto-snapshotting to usage-tracking.
diff --git a/lib/src/usage_tracking/model.dart b/lib/src/usage_tracking/model.dart
index c48c4d8..f10a6ee 100644
--- a/lib/src/usage_tracking/model.dart
+++ b/lib/src/usage_tracking/model.dart
@@ -59,8 +59,8 @@
/// Configures memory usage tracking.
///
/// Set [interval] to customize how often to verify memory usage.
-class UageTrackingConfig {
- const UageTrackingConfig({
+class UsageTrackingConfig {
+ const UsageTrackingConfig({
this.usageEventsConfig,
this.autoSnapshottingConfig,
this.interval = const Duration(seconds: 1),
@@ -124,14 +124,22 @@
///
/// Set [minDelayBetweenSnapshots] to make sure snapshots do not trigger each other.
class AutoSnapshottingConfig {
- const AutoSnapshottingConfig({
+ AutoSnapshottingConfig({
this.thresholdMb = 1024, // 1Gb
this.increaseMb = 512, // 0.5Gb
this.directory = 'dart_memory_snapshots',
this.directorySizeLimitMb = 10240, // 10Gb
this.minDelayBetweenSnapshots = const Duration(seconds: 10),
this.onSnapshot,
- });
+ }) {
+ if (minDelayBetweenSnapshots <= Duration.zero) {
+ throw ArgumentError.value(
+ minDelayBetweenSnapshots,
+ 'minDelayBetweenSnapshots',
+ 'must be positive',
+ );
+ }
+ }
/// The rss value in Mb that will trigger the first snapshot.
final int thresholdMb;
diff --git a/lib/src/usage_tracking/usage_tracking.dart b/lib/src/usage_tracking/usage_tracking.dart
index b671f02..c9b4bd8 100644
--- a/lib/src/usage_tracking/usage_tracking.dart
+++ b/lib/src/usage_tracking/usage_tracking.dart
@@ -16,10 +16,10 @@
/// Enables memory usage tracking, based on the value of [ProcessInfo.currentRss] (dart:io).
///
/// If tracking is already enabled, resets it.
-/// See [UageTrackingConfig] for details.
+/// See [UsageTrackingConfig] for details.
/// Use [stopMemoryUsageTracking] to stop auto-snapshotting.
/// Snapshotting operation may cause a delay in the main thread.
-void trackMemoryUsage(UageTrackingConfig config) {
+void trackMemoryUsage(UsageTrackingConfig config) {
stopMemoryUsageTracking();
if (config.isNoOp) return;
diff --git a/more_examples/autosnapshotting/lib/main.dart b/more_examples/autosnapshotting/lib/main.dart
index cd9699a..12f7089 100644
--- a/more_examples/autosnapshotting/lib/main.dart
+++ b/more_examples/autosnapshotting/lib/main.dart
@@ -55,7 +55,7 @@
final snapshots = <SnapshotEvent>[];
final usageEvents = <MemoryUsageEvent>[];
int lastRss = 0;
- late UageTrackingConfig config;
+ late UsageTrackingConfig config;
void _allocateMemory() {
setState(() {
@@ -68,7 +68,7 @@
void initState() {
super.initState();
- config = UageTrackingConfig(
+ config = UsageTrackingConfig(
autoSnapshottingConfig: AutoSnapshottingConfig(
onSnapshot: _handleSnapshotEvent,
thresholdMb: 400,
diff --git a/pubspec.yaml b/pubspec.yaml
index 5e5cd2f..ede2ce0 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -1,5 +1,5 @@
name: leak_tracker
-version: 5.0.0
+version: 6.0.0
description: A framework for memory leak tracking for Dart and Flutter applications.
repository: https://github.com/dart-lang/leak_tracker