nucleus rn

Nucleus.sh React SDK natif

Table des matières

1. Commencer
2. Usage
3. Comment contribuer

Commencer

Pour commencer avec le noyau, créez un compte dans le noyau et saisissez l'ID de l'application, puis utilisez le SDK pour commencer les événements de suivi.

Installation

Ce package a @react-native-async-storage/async-storage et @react-native-community/netinfo comme dépendances par les pairs. Installez-les d'abord si vous ne les avez pas

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

Procédez ensuite à l'installation nucleus-rn en tant que package NPM (recommandé)

 # with yarn
yarn add nucleus-rn

Usage

 import Nucleus from 'nucleus-rn' ;

Nucleus . init ( 'YOUR_APP_ID' ) ;

Remplacez 'YOUR_APP_ID' par l'ID unique de votre application. Vous pouvez l'obtenir ici.

Vous pouvez vérifier des exemples avec différents frameworks ici.

API

Le noyau prend en charge le passage des options suivantes comme deuxième argument à la méthode 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
} )

Suivi

Suivre les événements avec des données personnalisées en option

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

Suivi des erreurs

Suivez les erreurs avec un nom et l'objet d'erreur.

 Nucleus . trackError ( name , error ) ;

Par défaut, Nucleus enregistre un gestionnaire pour ErrorUtils.setGlobalHandler qui envoie des erreurs 'GlobalError' à l'API. Si vous souhaitez désactiver ce comportement, vous pouvez définir disableErrorReports sur true :

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

et attraper des erreurs manuellement à l'aide de Nucleus.trackError('an error', errObject) .

Identification des utilisateurs

Identifiez un utilisateur par un ID unique et définissez éventuellement des propriétés personnalisées.

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

Suivi de l'écran

Suivez les vues d'écran avec le nom de l'écran et les paramètres facultatifs.

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

Désactivation du suivi

Pour désactiver le suivi

 Nucleus . disableTracking ( ) ;

Activer le suivi

Pour permettre le suivi

 Nucleus . enableTracking ( ) ; 

Comment contribuer

Nous recherchons toujours des contributions de la communauté. Voici comment vous pouvez aider:

1. RAPPORT BOGS : Créez un problème Rapport détaillant le bug que vous avez trouvé.
2. Suggérer des caractéristiques : avez une excellente idée pour le noyau? N'hésitez pas à le mettre en avant en créant un problème.
3. Soumettez les demandes de traction : n'hésitez pas à corriger un bogue ou à ajouter une nouvelle fonctionnalité et à créer une demande de traction. Assurez-vous de suivre le style de code existant et écrivez des messages de validation clairs expliquant vos modifications.