Skip to content

Commit 68b3597

Browse files
authored
Add class docs and export the flutterflow_cli_base (#12)
* Add class docs and export the `flutterflow_cli_base` class * Update `export` method docs
1 parent ec75d7b commit 68b3597

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

lib/flutterflow_cli.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
library flutterflow_cli;
2+
3+
export 'package:flutterflow_cli/src/flutterflow_cli_base.dart';

lib/src/flutterflow_cli_base.dart

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,24 @@ import 'package:path/path.dart' as path_util;
77

88
const kDefaultEndpoint = 'https://api.flutterflow.io/v1';
99

10+
/// The `FlutterFlowApi` class provides methods for exporting code from a
11+
/// FlutterFlow project.
1012
class FlutterFlowApi {
13+
/// Exports the code from a FlutterFlow project.
14+
///
15+
/// * [token] is the FlutterFlow API token for accessing the project.
16+
/// * [projectId] is the ID of the project to export.
17+
/// * [destinationPath] is the path where the exported code will be saved.
18+
/// * [includeAssets] flag indicates whether to include project assets
19+
/// in the export.
20+
/// * [endpoint] is the API endpoint to use for exporting the code.
21+
/// * [branchName] is the name of the branch to export from (optional).
22+
/// * [unzipToParentFolder] flag indicates whether to unzip the exported code
23+
/// to the parent folder.
24+
/// * [fix] flag indicates whether to fix any issues in the exported code.
25+
///
26+
/// Returns a [Future] that completes with the path to the exported code, or
27+
/// throws an error if the export fails.
1128
static Future<String?> export({
1229
required String token,
1330
required String projectId,

0 commit comments

Comments
 (0)