nucleus rn

Nucleus.sh React native SDK

Inhaltsverzeichnis

1. Erste Schritte
2. Verwendung
3. Wie man beiträgt

Erste Schritte

Um mit Nucleus zu beginnen, erstellen Sie ein Konto bei Nucleus und schnappen Sie sich die App -ID. Verwenden Sie dann die SDK, um die Verfolgung von Ereignissen zu beginnen.

Installation

Dieses Paket enthält @react-native-async-storage/async-storage und @react-native-community/netinfo als Peer-Abhängigkeiten. Installieren Sie sie zuerst, wenn Sie sie nicht haben

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

Installieren Sie dann nucleus-rn als NPM-Paket (empfohlen)

 # with yarn
yarn add nucleus-rn

Verwendung

 import Nucleus from 'nucleus-rn' ;

Nucleus . init ( 'YOUR_APP_ID' ) ;

Ersetzen Sie 'YOUR_APP_ID' durch die eindeutige ID Ihrer App. Sie können es hier bekommen.

Sie können hier Beispiele mit verschiedenen Frameworks überprüfen.

API

Der Nucleus unterstützt die folgenden Optionen als zweites Argument an die Methode 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
} )

Verfolgung

Ereignisse mit optionalen benutzerdefinierten Daten verfolgen

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

Fehlerverfolgung

Verfolgen Sie Fehler mit einem Namen und dem Fehlerobjekt.

 Nucleus . trackError ( name , error ) ;

Standardmäßig registriert der Kern einen Handler für ErrorUtils.setGlobalHandler , der 'GlobalError' Fehler an die API sendet. Wenn Sie dieses Verhalten deaktivieren möchten, können Sie disableErrorReports auf true festlegen:

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

und fangen Fehler manuell unter Verwendung von Nucleus.trackError('an error', errObject) .

Benutzeridentifikation

Identifizieren Sie einen Benutzer mit einer eindeutigen ID und setzen Sie optional benutzerdefinierte Eigenschaften.

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

Bildschirmverfolgung

Verfolgen Sie die Bildschirmansichten mit dem Bildschirmnamen und optionalen Parametern.

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

Deaktivierung der Verfolgung

Verfolgung zu deaktivieren

 Nucleus . disableTracking ( ) ;

Verfolgung aktivieren

Um die Verfolgung zu ermöglichen

 Nucleus . enableTracking ( ) ; 

Wie man beiträgt

Wir sind immer auf der Suche nach Beiträgen der Community. So können Sie helfen:

1. Berichtsfehler : Erstellen Sie einen Problembericht, in dem der Fehler beschrieben wird, den Sie gefunden haben.
2. Merkmale vorschlagen : Haben Sie eine gute Idee für den Nucleus? Zögern Sie nicht, es durchzuführen, indem Sie ein Problem erstellen.
3. Pull -Anfragen senden : Führen Sie gerne einen Fehler oder fügen Sie eine neue Funktion hinzu und erstellen Sie eine Pull -Anfrage. Folgen Sie dem vorhandenen Codestil und schreiben Sie klare Commit -Nachrichten, die Ihre Änderungen erläutern.