Golubets

https://pub.dev/packages/golubets
Admin
Golubets is a code generator tool that makes communication between Flutter and native platforms...
Tokens:4,715
Snippets:84
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Import Golubets in Dart Code

Source: https://pub.dev/packages/golubets/install

Import the golubets package into your Dart files to start using its functionalities.

```dart
import 'package:golubets/golubets.dart';
```

--------------------------------

### Control Threading with TaskQueue Annotation

Source: https://pub.dev/packages/golubets

Specify the threading model for background operations using the `TaskQueue` annotation. This example uses `TaskQueueType.serialBackgroundThread` for serial execution on a background thread.

```dart
@HostApi()
abstract class BackgroundApi {
  @TaskQueue(type: TaskQueueType.serialBackgroundThread)
  @Async(type: AsyncType.await())
  void doStuffAtBackground();
}
```

--------------------------------

### Define Generics with Sealed Classes

Source: https://pub.dev/packages/golubets

Use sealed classes to define generic result types for type-safe collections. This example shows a `SomeResult` with `Success` and `Error` states, supporting generic types `R` and `E`.

```dart
sealed class SomeResult<R, E> {
  const SomeResult();
}

class Success<R, E> extends SomeResult<R, E> {
  const Success(this.value);
  final R value;
}

class Error<R, E> extends SomeResult<R, E> {
  const Error(this.error);
  final E error;
}

@HostApi()
abstract class ExampleHostApi {
  SomeResult<List<int>, String> generateNumbers();
}
```

--------------------------------

### Multi-Instance APIs

Source: https://pub.dev/packages/golubets

Illustrates how to create multiple independent instances of an API using unique message channel suffixes.

```APIDOC
## Multi-Instance APIs

### Description
Create multiple API instances that operate independently by assigning unique channels using the `messageChannelSuffix`.

### Usage
Instantiate the API class multiple times, providing a distinct `messageChannelSuffix` for each instance to ensure independent communication channels.

### Example
```dart
final api1 = MyApi(messageChannelSuffix: 'instance1');
final api2 = MyApi(messageChannelSuffix: 'instance2');
// Both operate independently!
```
```

--------------------------------

### Generate Platform Code with Golubets

Source: https://pub.dev/packages/golubets

Run this command to generate platform-specific code from your API definition file. Ensure your API definition is located at the specified path.

```bash
dart run golubets --input golubtsi/api.dart
```

--------------------------------

### Task Queue Support

Source: https://pub.dev/packages/golubets

Demonstrates how to control threading behavior for background operations using the `TaskQueue` annotation.

```APIDOC
## Task Queue Support

### Description
Control threading behavior for background operations using the `TaskQueue` annotation to specify the threading model.

### Method
- `doStuffAtBackground()`: An asynchronous method that is configured to run on a serial background thread.

### Annotation
- `@TaskQueue(type: TaskQueueType.serialBackgroundThread)`: Specifies that the annotated method should be executed on a serial background thread.
- `@Async(type: AsyncType.await())`: Indicates the method uses modern concurrency for asynchronous operations.

### Example
```dart
@HostApi()
abstract class BackgroundApi {
  @TaskQueue(type: TaskQueueType.serialBackgroundThread)
  @Async(type: AsyncType.await())
  void doStuffAtBackground();
}
```
```

--------------------------------

### Create Multiple API Instances

Source: https://pub.dev/packages/golubets

Instantiate multiple independent API clients by providing unique `messageChannelSuffix` values. This allows for concurrent and isolated operations.

```dart
final api1 = MyApi(messageChannelSuffix: 'instance1');
final api2 = MyApi(messageChannelSuffix: 'instance2');
// Both operate independently!
```

--------------------------------

### Default Parameters

Source: https://pub.dev/packages/golubets

Showcases how to define default values for parameters in Dart, which are then reflected in the generated Swift and Kotlin code.

```APIDOC
## Default Parameters (Swift & Kotlin)

### Description
Define default values for parameters in Dart classes, which are automatically generated as default parameters in Swift and Kotlin, reducing boilerplate code.

### Dart Example
```dart
class UserPreferences {
  const UserPreferences({
    required this.userId,
    this.theme = 'light', // Generated with default in Swift/Kotlin
    this.notifications = true, // No more verbose constructors!
    this.language = 'en',
  });

  final String userId;
  final String theme;
  final bool notifications;
  final String language;
}
```

### Swift Example
```swift
public struct UserPreferences: Hashable {
  public init(
    userId: String,
    theme: String = "light",
    notifications: Bool = true,
    language: String = "en"
  ) {
    self.userId = userId
    self.theme = theme
    self.notifications = notifications
    self.language = language
  }
  let userId: String
  let theme: String
  let notifications: Bool
  let language: String
}
```

### Kotlin Example
```kotlin
data class UserPreferences (
  val userId: String,
  val theme: String = "light",
  val notifications: Boolean = true,
  val language: String = "en"
)
```
```

--------------------------------

### Define Async Methods in Host API

Source: https://pub.dev/packages/golubets

Define synchronous, callback-based, and modern async methods within a Host API. Use `@async` for traditional callbacks and `@Async` with `AsyncType.await` for Swift async/await and Kotlin coroutines. Configure error handling with `isSwiftThrows`.

```dart
// Choose your async style
@HostApi()
abstract class MyApi {
  String syncMethod(); // Immediate response

  @async 
  void callbackMethod(); // Traditional callbacks  

  @Async(type: AsyncType.await(isSwiftThrows: false))
  Future<String> modernMethod();  // Swift async and Kotlin coroutines
}
```

--------------------------------

### Add Golubets to Flutter Project

Source: https://pub.dev/packages/golubets

Use this command to add Golubets as a development dependency to your Flutter project.

```bash
flutter pub add --dev golubets
```

--------------------------------

### Dart Pub Downgrade Command

Source: https://pub.dev/packages/golubets/score

This command is used to downgrade dependencies. The documentation notes that `pub downgrade` does not expose any static analysis errors.

```bash
pub downgrade
```

--------------------------------

### Golubets Dependency in pubspec.yaml

Source: https://pub.dev/packages/golubets/install

This is how the golubets dependency will appear in your pubspec.yaml file after running the `dart pub add` command.

```yaml
dependencies:
  golubets: ^1.3.2
```

--------------------------------

### Add Golubets Dependency with Dart CLI

Source: https://pub.dev/packages/golubets/install

Use this command to add golubets as a dependency in your Dart project. It automatically updates your pubspec.yaml file.

```bash
dart pub add golubets
```

--------------------------------

### API Method Definitions

Source: https://pub.dev/packages/golubets

Defines different asynchronous communication styles supported by the Host API, including synchronous, callback-based, and modern concurrency patterns.

```APIDOC
## API Method Definitions

### Description
This section illustrates how to define API methods within the `HostApi` interface, showcasing different asynchronous communication patterns.

### Methods
- `syncMethod()`: A synchronous method that returns an immediate response.
- `callbackMethod()`: An asynchronous method using traditional callbacks, annotated with `@async`.
- `modernMethod()`: An asynchronous method leveraging modern concurrency features like Swift async/await and Kotlin coroutines, annotated with `@Async`.

### Example
```dart
// Choose your async style
@HostApi()
abstract class MyApi {
  String syncMethod(); // Immediate response

  @async 
  void callbackMethod(); // Traditional callbacks  

  @Async(type: AsyncType.await(isSwiftThrows: false))
  Future<String> modernMethod();  // Swift async and Kotlin coroutines
}
```
```

--------------------------------

### Define Swift Struct with Default Parameters

Source: https://pub.dev/packages/golubets

Define a Swift struct with default values for its initializer parameters. This mirrors Dart's default parameter functionality for cleaner native APIs.

```swift
public struct UserPreferences: Hashable {
  public init(
    userId: String,
    theme: String = "light",
    notifications: Bool = true,
    language: String = "en"
  ) {
    self.userId = userId
    self.theme = theme
    self.notifications = notifications
    self.language = language
  }
  let userId: String
  let theme: String
  let notifications: Bool
  let language: String
}
```

--------------------------------

### Define Kotlin Data Class with Default Parameters

Source: https://pub.dev/packages/golubets

Define a Kotlin data class with default values for its constructor parameters. This aligns with Dart's default parameter feature, simplifying native calls.

```kotlin
data class UserPreferences (
  val userId: String,
  val theme: String = "light",
  val notifications: Boolean = true,
  val language: String = "en"
)
```

--------------------------------

### Dart Dependency Update Command

Source: https://pub.dev/packages/golubets/score

This command is used to update dependencies, specifically targeting the 'analyzer' package with major version updates. It is recommended when a package constraint does not support a stable version.

```bash
dart pub upgrade --major-versions analyzer
```

--------------------------------

### Define Dart Class with Default Parameters

Source: https://pub.dev/packages/golubets

Define a Dart class with default values for its parameters. These defaults are automatically generated in Swift and Kotlin, reducing boilerplate code.

```dart
class UserPreferences {
  const UserPreferences({
    required this.userId,
    this.theme = 'light', // Generated with default in Swift/Kotlin
    this.notifications = true, // No more verbose constructors!
    this.language = 'en',
  });

  final String userId;
  final String theme;
  final bool notifications;
  final String language;
}
```

--------------------------------

### Dart Lint: Angle Brackets as HTML

Source: https://pub.dev/packages/golubets/score

This lint indicates that angle brackets are being interpreted as HTML. It is found in lib/src/ast.dart. To reproduce, ensure you are using lints_core and run `dart analyze lib/src/ast.dart`.

```dart
    ╷
562 │   /// The base name of the [TypeDeclaration] (ex 'Foo' to 'Foo<Bar>?').
    │                                                               ^^^^^
    ╵

```

```dart
    ╷
568 │   /// Whether the type arguments to the entity (ex 'Bar' to 'Foo<Bar>?').
    │                                                                 ^^^^^
    ╵

```

--------------------------------

### Dart Dependency Outdated Check

Source: https://pub.dev/packages/golubets/score

This command checks for outdated dependencies in a Dart project, excluding development dependencies and dependency overrides. It helps in identifying packages that can be updated.

```bash
dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides
```
Tokens:
Raw