Skip to content

Rename subDir to dir in initFlutter, treat as relative or absolute #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jheld wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −5
Open

Rename subDir to dir in initFlutter, treat as relative or absolute #293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions hive_flutter/lib/src/hive_extensions.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import 'package:hive_ce_flutter/src/wrapper/path.dart' as path_helper;

/// Flutter extensions for Hive.
extension HiveX on HiveInterface {
/// Initializes Hive with the path from [getApplicationDocumentsDirectory].
/// Initializes Hive with the path from [getApplicationDocumentsDirectory], or as an absolute path.
///
/// You can provide a [subDir] where the boxes should be stored.
/// You can provide a [dir] where the boxes should be stored.
///
/// Also registers the flutter type adapters
/// - [colorAdapterTypeId] - The type id for the color adapter (default: 200)
/// - [timeOfDayAdapterTypeId] - The type id for the time of day adapter (default: 201)
Future<void> initFlutter([
String? subDir,
String? dir,
HiveStorageBackendPreference backendPreference =
HiveStorageBackendPreference.native,
int? colorAdapterTypeId,
Expand All @@ -24,8 +24,18 @@ extension HiveX on HiveInterface {

String? path;
if (!kIsWeb) {
final appDir = await getApplicationDocumentsDirectory();
path = path_helper.join(appDir.path, subDir);
// join accepts the latter arguments as nullable so it is safe
// to consider it "relative" even in that case. If the user wants an
// absolute path pointing to the base of a well-defined
// path (including one with built-in dart support),
// different from getApplicationDocumentsDirectory,
// then they should pass that directory in.
if (dir == null || path_helper.isRelative(dir)) {
final appDir = await getApplicationDocumentsDirectory();
path = path_helper.join(appDir.path, dir);
} else {
path = dir;
}
}

init(
Expand Down