Skip to content

Commit 480e1f3

Browse files
committed
Add JSDocs
1 parent 39ccfda commit 480e1f3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/index.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ import { NativeModules, Platform } from 'react-native';
22

33
const TrackingTransparency = NativeModules.TrackingTransparency;
44

5+
/**
6+
* The Tracking Authorization Status. See [ATTrackingManager.AuthorizationStatus](https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus)
7+
*/
58
export type TrackingStatus =
69
| 'unavailable'
710
| 'denied'
@@ -10,7 +13,9 @@ export type TrackingStatus =
1013
| 'not-determined';
1114

1215
/**
16+
* Requests permission to track the user. Requires an [`NSUserTrackingUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nsusertrackingusagedescription) key in your `Info.plist`. (See [iOS 14 Tracking API](https://developer.apple.com/documentation/apptrackingtransparency))
1317
*
18+
* @platform iOS 14
1419
*/
1520
export async function requestTrackingPermission(): Promise<TrackingStatus> {
1621
if (Platform.OS !== 'ios') return 'unavailable';

0 commit comments

Comments
 (0)