Skip to content

Commit f65ecda

Browse files
committed
📝 clarify Hive backend initialization requirements in documentation
1 parent 66eb710 commit f65ecda

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

packages/hyper_storage/docs/backends.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,10 @@ void main() async {
7474
}
7575
```
7676

77-
> Hive backend requires initialization of Hive before use. Hyper Storage do not handle Hive initialization for you.
78-
> You need to initialize Hive in your application before using the Hive backend. For example:
77+
### IMPORTANT
78+
> Hive backend requires initialization of Hive before use. Hyper Storage doesn't handle Hive initialization for you as
79+
> the initialization depends on whether the project is being used in Flutter or pure Dart environment.
80+
> You need to initialize Hive in your application before using the Hive backend.
7981
8082
## [Secure Storage Backend](https://pub.dev/packages/hyper_storage_secure):
8183

@@ -121,7 +123,7 @@ requirements.
121123

122124
```dart
123125
// Define your custom backend by implementing the StorageBackend interface.
124-
class YourCustomBackend implements StorageBackend {
126+
class YourCustomBackend extends StorageBackend {
125127
// Implement all required methods here.
126128
}
127129
```

0 commit comments

Comments
 (0)