mirror of
https://github.com/Tencent/MMKV.git
synced 2026-10-29 12:12:38 +08:00
31 lines
1006 B
Markdown
31 lines
1006 B
Markdown
# mmkv\_platform\_interface
|
|
|
|
A common platform interface for the [`MMKV`][1] plugin.
|
|
|
|
This interface allows platform-specific implementations of the `MMKV`
|
|
plugin, as well as the plugin itself, to ensure they are supporting the
|
|
same interface.
|
|
|
|
# Usage
|
|
|
|
To implement a new platform-specific implementation of `MMKV`, extend
|
|
[`MMKVPluginPlatform`][2] with an implementation that performs the
|
|
platform-specific behavior, and when you register your plugin, set the default
|
|
`MMKVPluginPlatform` by calling
|
|
`MMKVPluginPlatform.instance = MyMMKVPluginPlatform()`.
|
|
|
|
Checkout [`mmkv_ios`][3] or [`mmkv_android`][4] for example.
|
|
|
|
# Note on breaking changes
|
|
|
|
Strongly prefer non-breaking changes (such as adding a method to the interface)
|
|
over breaking changes for this package.
|
|
|
|
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
|
|
on why a less-clean interface is preferable to a breaking change.
|
|
|
|
[1]: ../mmkv
|
|
[2]: lib/mmkv_platform_interface.dart
|
|
[3]: ../mmkv_ios
|
|
[4]: ../mmkv_android
|