Skip to content

Commit

Permalink
Merge branch 'main' into feature/generate-adapters
Browse files Browse the repository at this point in the history
  • Loading branch information
Rexios80 committed Nov 19, 2024
2 parents f72bb88 + 6ca6e68 commit 65bf44c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion hive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,8 @@ All of the generated files should be checked into version control. These files a

### Use the Hive registrar

The Hive Registrar allows you to register all generated TypeAdapters in one call

```dart
import 'dart:io';
import 'package:hive_ce/hive.dart';
Expand Down Expand Up @@ -286,7 +288,7 @@ void example() async {

The Hive schema is a generated yaml file that contains the information necessary to incrementally update the generated TypeAdapters as your model classes evolve.

Some migrations might require manual modifications to the Hive schema file. One example is field renaming. Without manual intervention, the generator will see both an added and removed field. To resolve this, manually rename the field in the schema.
Some migrations may require manual modifications to the Hive schema file. One example is class/field renaming. Without manual intervention, the generator will see both an added and removed class/field. To resolve this, manually rename the class/field in the schema.

### Migrating to `GenerateAdapters`

Expand Down

0 comments on commit 65bf44c

Please sign in to comment.