react-native-jsi-contacts
The current react-native-contacts library uses the React Native Bridge to convert the native Java/Objective-C types to JavaScript values. This is asynchronous, batched, and serializes the huge contacts list in the native world (write into WritableArray/WritableMap, then let the Bridge convert to JSON), then deserializes it on the JavaScript side using JSON. It is therefore slow.
react-native-jsi-contacts uses JSI to be way faster.
- Direct invocation (no batching!)
- No JSON serialization happening
- Directly convert object into JSI Types
- Lazily get individual Contact fields (
jsi::HostObjectlazy-get)
⚠️ react-native-jsi-contacts only works on Android. If you want me to implement iOS support, consider funding the project.
Performance
The library uses almost the same native "getContacts()" function as react-native-contacts (minor tweaks to not use the Bridge types WritableArray/WritableMap), so the only difference is the conversion speed.
For 25 contacts, I have measured an average speed increase of ~35%, this greatly scales with the amount of contacts you have though.
LOG JSI: Contacts Permission: granted
LOG JSI: Got: 25 contacts in 55.14947900176048ms.
LOG Bridge: Contacts Permission: granted
LOG Bridge: Got: 25 contacts in 74.15260401368141ms.
For 25 contacts, the conversion between the native Java Contacts list and the JavaScript Contacts list takes only ~3 milliseconds!
Installation
-
Install using npm/yarn
npm install react-native-jsi-contacts
-
Add this code:
JsiContactsModule.install(reactApplicationContext);
to your
JSIModulePackage'sgetJSIModulesmethod. See the react-native-mmkv installation guide on how to create aJSIModulePackage.
Sponsors
This project is sponsored by Galaxycard.
Usage
Get a list of all contacts:
import { getContactsAsync } from "react-native-jsi-contacts";
const contacts = await getContactsAsync();
Get a hashsum to compare for any changes in the contact book:
import { getHashAsync } from "react-native-jsi-contacts";
import { MMKV } from "react-native-mmkv";
const storage = new MMKV();
const hash = await getHashAsync();
const previousHash = storage.getString("contactsHash")
if (previousHash !== hash) {
// get all contacts and reload hash now.
}
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
Thanks
- Thanks to GalaxyCard for sponsoring this project
- Thanks to react-native-contacts for the native "
getContacts()" implementation
35 Aug 16, 2022
5 May 24, 2022
10 Dec 3, 2022
2 Jun 18, 2022
3 Jun 27, 2022
1 Feb 17, 2022
37 Mar 7, 2022
12 Nov 11, 2022
17 Oct 10, 2022
82 Nov 17, 2022
228 Dec 18, 2022
15.2k Jan 2, 2023
5 Sep 5, 2022
30 Oct 30, 2022
96 Dec 5, 2022
83 Nov 28, 2022
969 Jan 3, 2023
60 Dec 21, 2022