nucleus rn

Nucleus.sh bereaksi SDK asli

Daftar isi

1. Memulai
2. Penggunaan
3. Bagaimana berkontribusi

Memulai

Untuk memulai dengan Nucleus, buat akun di Nucleus dan ambil ID aplikasi, lalu gunakan SDK untuk mulai melacak acara.

Instalasi

Paket ini memiliki @react-native-async-storage/async-storage dan @react-native-community/netinfo sebagai dependensi sebaya. Instal mereka terlebih dahulu jika Anda tidak memilikinya

yarn add @react-native-async-storage/async-storage @react-native-community/netinfo

Kemudian lanjutkan untuk memasang nucleus-rn sebagai paket NPM (disarankan)

 # with yarn
yarn add nucleus-rn

Penggunaan

 import Nucleus from 'nucleus-rn' ;

Nucleus . init ( 'YOUR_APP_ID' ) ;

Ganti 'YOUR_APP_ID' dengan ID unik aplikasi Anda. Anda bisa mendapatkannya di sini.

Anda dapat memeriksa contoh dengan kerangka kerja yang berbeda di sini.

API

Nucleus mendukung melewati opsi berikut sebagai argumen kedua ke metode Nucleus.init() :

 Nucleus . init ( 'APP_ID' , {
  appVersion : '0.0.0' , // the version of your application
  endpoint : 'wss://app.nucleus.sh' , // only option, we don't allow self hosting yet :(
  disableInDev : true , // disable in development mode. We recommend not to call
                      // `init` method, as that will be more reliable.
  debug : false , // if set to `true`, will log a bunch of things.
  disableTracking : false , // will not track anything. You can also use `Nucleus.disableTracking()`.
                          // note that some events will still be added to the queue, so if you call
                          // Nucleus.enableTracking() again, they will be sent to the server.
  reportInterval : 2 * 1000 , // at which interval the events are sent to the server.
  sessionTimeout : 60 * 30 * 1000 , // time after which the session is ended
  cutoff : 60 * 60 * 48 * 1000 , // time after which event that were not sent yet are deleted
  disableErrorReports : false , // wether to disable error tracking
} )

Pelacakan

Lacak acara dengan data khusus opsional

 Nucleus . track ( "click" , { foo : 'bar' } ) ;

Pelacakan kesalahan

Lacak kesalahan dengan nama dan objek kesalahan.

 Nucleus . trackError ( name , error ) ;

Secara default nukleus mendaftarkan penangan untuk ErrorUtils.setGlobalHandler yang mengirimkan kesalahan 'GlobalError' ke API. Jika Anda ingin menonaktifkan perilaku ini, Anda dapat mengatur disableErrorReports ke true :

 Nucleus . init ( 'APP_ID' , { disableErrorReports : true } )

dan menangkap kesalahan secara manual menggunakan Nucleus.trackError('an error', errObject) .

Identifikasi Pengguna

Identifikasi pengguna dengan ID yang unik dan atur secara opsional Properti Kustom.

 Nucleus . identify ( '04f8846d-ecca-4a81-8740-f6428ceb7f7b' , { firstName : 'Jordan' , lastName : 'Walke' } ) ;

Pelacakan layar

Lacak tampilan layar dengan nama layar dan parameter opsional.

 Nucleus . page ( '/about' , { foo : 'baz' } ) ;

Menonaktifkan pelacakan

Untuk menonaktifkan pelacakan

 Nucleus . disableTracking ( ) ;

Mengaktifkan pelacakan

Untuk memungkinkan pelacakan

 Nucleus . enableTracking ( ) ; 

Bagaimana berkontribusi

Kami selalu mencari kontribusi dari komunitas. Begini cara Anda dapat membantu:

1. Laporan bug : Buat laporan masalah yang merinci bug yang Anda temukan.
2. Sarankan fitur : Punya ide bagus untuk nukleus? Jangan ragu untuk mengedepankannya dengan membuat masalah.
3. Kirim Permintaan Tarik : Jangan ragu untuk memperbaiki bug atau menambahkan fitur baru dan membuat permintaan tarik. Pastikan untuk mengikuti gaya kode yang ada, dan tulis pesan komit yang jelas menjelaskan perubahan Anda.