Skip to content

Document deprecation of list/array flag values #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
confidence-agent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document deprecation of list/array flag values #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ await confidence.getString("[FLAG]", "Default"))
The schema of the property plays a crucial role in resolving the property, if the schema type matches the asked type, the value will be returned otherwise
we expect default value to be returned.

> **Deprecated:** list/array flag schemas and flag values are deprecated. Existing list flags continue to resolve (e.g. via `resolveKey<List<dynamic>>`), but new flags should avoid list properties. This applies only to flag values; lists in context and event data remain supported.

### Send custom Events
we can send custom events to the confidence sdk like following:

Expand Down
5 changes: 5 additions & 0 deletions lib/confidence_flutter_sdk.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ class ConfidenceFlutterSdk {
return resolveKey(key) ?? defaultValue;
}

/// Resolves the flag value at the dot-separated [key] as [T].
///
/// Note: resolving list/array flag values (e.g. `T` = `List<dynamic>`) is
/// deprecated. It keeps working for existing flags, but new flags should
/// not use list schemas. Lists in context and event data are unaffected.
T? resolveKey<T>(String key) {
List<String> keys = key.split(".");
Map<String, dynamic> flags = _flags;
Expand Down
Loading