body method
Defines the actual body code. path
is passed relative to lib
, baseName
is the filename, and className
is the filename converted to Pascal case.
実際の本体コードを定義します。path
にlib
からの相対パス、baseName
にファイル名が渡され、className
にファイル名をパスカルケースに変換した値が渡されます。
Implementation
@override
String body(String baseName, String className) {
return """
`ModelRef`は下記のように利用する。
## 概要
$excerpt
## 作成方法
- モデルへの参照パスから定義
```dart
ModelRef<UserModel>.fromPath("user/\$userId");
```
## 値の取得
- データの取得
```dart
final data = modelRef.value;
```
- ドキュメントIDを取得
```dart
final uid = modelRef.uid;
```
- パスを取得。
```dart
final path = modelRef.modelQuery.path;
```
- データを保存
```dart
await modelRef.save(modelRef.value.copyWith());
```
- データの削除
```dart
await modelRef.delete();
```
## Jsonへの変換
```dart
final json = modelRef.toJson();
```
## Jsonからの変換
```dart
final modelRef = ModelRef.fromJson(json);
```
""";
}