feat: Update the onAppSessionStart documtation

lifeomic · Sep 22, 2023 · 5eeeef1 · 5eeeef1
1 parent fae09e9
commit 5eeeef1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -225,14 +225,17 @@ export default function App() {
 session starts (user sign-in/sign-up, app refresh, etc.). It can be used for
 analytics purposes, checking subscription status, etc.
 
+`onAppSessionStart` is invoked with an object containing a `resumeAppSession`.
+The app session will be paused until `resumeAppSession` is invoked.
+
 ````typescript
 ```typescript
 import React, { FC } from 'react';
 import { authConfig } from './authConfig';
-import { RootProviders, RootStack } from '@lifeomic/react-native-sdk';
+import { RootProviders, RootStack, OnAppSessionStartParams } from '@lifeomic/react-native-sdk';
 
 export default function App() {
-  const onAppSessionStart = async (resumeAppSession: () => void) => {
+  const onAppSessionStart = async ({ resumeAppSession }: OnAppSessionStartParams) => {
    // track app session start metric
    await trackAppSessionStart();
    resumeAppSession();

diff --git a/src/common/DeveloperConfig.ts b/src/common/DeveloperConfig.ts
@@ -65,7 +65,7 @@ export type Navigator<
   React.ComponentType<Props>
 >;
 
-type OnAppSessionStartParams = {
+export type OnAppSessionStartParams = {
   resumeAppSession: () => void;
 };