Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

Commit f58986f

Browse files
committed
docs(core): generate docs
1 parent 894206f commit f58986f

6 files changed

+35
-35
lines changed

packages/core/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
**Ƭ Integration**: * `function` | `object`
2727
*
2828

29-
*Defined in analytics.ts:170*
29+
*Defined in [analytics.ts:170](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L170)*
3030

3131
___
3232
<a id="writekey"></a>
@@ -36,7 +36,7 @@ ___
3636
**Ƭ WriteKey**: * `string` &#124; `object`
3737
*
3838

39-
*Defined in analytics.ts:172*
39+
*Defined in [analytics.ts:172](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L172)*
4040

4141
___
4242

packages/core/docs/classes/analytics.client.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
**● ready**: *`false`* = false
3838

39-
*Defined in analytics.ts:13*
39+
*Defined in [analytics.ts:13](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L13)*
4040

4141
Whether the client is ready to send events to Segment.
4242

@@ -52,7 +52,7 @@ ___
5252

5353
**alias**(newId: *`string`*): `this`
5454

55-
*Defined in analytics.ts:115*
55+
*Defined in [analytics.ts:115](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L115)*
5656

5757
Merge two user identities, effectively connecting two sets of user data as one. This may not be supported by all integrations.
5858

@@ -73,7 +73,7 @@ ___
7373

7474
**catch**(handler: *[ErrorHandler]()*): `this`
7575

76-
*Defined in analytics.ts:23*
76+
*Defined in [analytics.ts:23](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L23)*
7777

7878
Catch React-Native bridge errors
7979

@@ -94,7 +94,7 @@ ___
9494

9595
**configure**(): [Configuration](../interfaces/analytics.chainedconfiguration.configuration.md)
9696

97-
*Defined in analytics.ts:43*
97+
*Defined in [analytics.ts:43](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L43)*
9898

9999
Configure the Analytics module.
100100

@@ -119,7 +119,7 @@ ___
119119

120120
**disable**(): `this`
121121

122-
*Defined in analytics.ts:154*
122+
*Defined in [analytics.ts:154](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L154)*
123123

124124
Completely disable the sending of any analytics data.
125125

@@ -134,7 +134,7 @@ ___
134134

135135
**enable**(): `this`
136136

137-
*Defined in analytics.ts:144*
137+
*Defined in [analytics.ts:144](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L144)*
138138

139139
Enable the sending of analytics data. Enabled by default.
140140

@@ -149,7 +149,7 @@ ___
149149

150150
**flush**(): `this`
151151

152-
*Defined in analytics.ts:135*
152+
*Defined in [analytics.ts:135](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L135)*
153153

154154
Trigger an upload of all queued events.
155155

@@ -164,7 +164,7 @@ ___
164164

165165
**group**(groupId: *`string`*, traits?: *[JsonMap]()*): `this`
166166

167-
*Defined in analytics.ts:102*
167+
*Defined in [analytics.ts:102](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L102)*
168168

169169
Associate a user with a group, organization, company, project, or w/e _you_ call them.
170170

@@ -186,7 +186,7 @@ ___
186186

187187
**identify**(userId: *`string`*, traits?: *[JsonMap]()*): `this`
188188

189-
*Defined in analytics.ts:90*
189+
*Defined in [analytics.ts:90](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L90)*
190190

191191
Associate a user with their unique ID and record traits about them.
192192

@@ -208,7 +208,7 @@ ___
208208

209209
**reset**(): `this`
210210

211-
*Defined in analytics.ts:125*
211+
*Defined in [analytics.ts:125](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L125)*
212212

213213
Reset any user state that is cached on the device.
214214

@@ -223,7 +223,7 @@ ___
223223

224224
**screen**(name: *`string`*, properties?: *[JsonMap]()*): `this`
225225

226-
*Defined in analytics.ts:76*
226+
*Defined in [analytics.ts:76](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L76)*
227227

228228
Record the screens or views your users see.
229229

@@ -245,7 +245,7 @@ ___
245245

246246
**track**(event: *`string`*, properties?: *[JsonMap]()*): `this`
247247

248-
*Defined in analytics.ts:58*
248+
*Defined in [analytics.ts:58](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L58)*
249249

250250
Record the actions your users perform.
251251

packages/core/docs/interfaces/analytics.chainedconfiguration.android.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
*Inherited from [Base](analytics.chainedconfiguration.base.md).[android](analytics.chainedconfiguration.base.md#android)*
3131

32-
*Defined in analytics.ts:193*
32+
*Defined in [analytics.ts:193](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L193)*
3333

3434
Access Android specific settings
3535

@@ -42,7 +42,7 @@ ___
4242

4343
**disableDeviceId**(): `this`
4444

45-
*Defined in analytics.ts:247*
45+
*Defined in [analytics.ts:247](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L247)*
4646

4747
Disable the collection of the device identifier. Enabled by default.
4848

@@ -63,7 +63,7 @@ ___
6363

6464
*Inherited from [Base](analytics.chainedconfiguration.base.md).[ios](analytics.chainedconfiguration.base.md#ios)*
6565

66-
*Defined in analytics.ts:189*
66+
*Defined in [analytics.ts:189](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L189)*
6767

6868
Access iOS specific settings
6969

@@ -78,7 +78,7 @@ ___
7878

7979
*Inherited from [Base](analytics.chainedconfiguration.base.md).[setup](analytics.chainedconfiguration.base.md#setup)*
8080

81-
*Defined in analytics.ts:185*
81+
*Defined in [analytics.ts:185](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L185)*
8282

8383
Finalize the configuration and initialize the Analytics client.
8484

packages/core/docs/interfaces/analytics.chainedconfiguration.base.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
**android**(): [Android](analytics.chainedconfiguration.android.md)
3232

33-
*Defined in analytics.ts:193*
33+
*Defined in [analytics.ts:193](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L193)*
3434

3535
Access Android specific settings
3636

@@ -43,7 +43,7 @@ ___
4343

4444
**ios**(): [iOS](analytics.chainedconfiguration.ios.md)
4545

46-
*Defined in analytics.ts:189*
46+
*Defined in [analytics.ts:189](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L189)*
4747

4848
Access iOS specific settings
4949

@@ -56,7 +56,7 @@ ___
5656

5757
**setup**(writeKey: *[WriteKey](../#writekey)*): `Promise`<[Client](../classes/analytics.client.md)>
5858

59-
*Defined in analytics.ts:185*
59+
*Defined in [analytics.ts:185](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L185)*
6060

6161
Finalize the configuration and initialize the Analytics client.
6262

packages/core/docs/interfaces/analytics.chainedconfiguration.configuration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
*Inherited from [Base](analytics.chainedconfiguration.base.md).[android](analytics.chainedconfiguration.base.md#android)*
3636

37-
*Defined in analytics.ts:193*
37+
*Defined in [analytics.ts:193](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L193)*
3838

3939
Access Android specific settings
4040

@@ -47,7 +47,7 @@ ___
4747

4848
**debug**(): `this`
4949

50-
*Defined in analytics.ts:223*
50+
*Defined in [analytics.ts:223](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L223)*
5151

5252
**Returns:** `this`
5353

@@ -58,7 +58,7 @@ ___
5858

5959
**flushAt**(at: *`number`*): `this`
6060

61-
*Defined in analytics.ts:218*
61+
*Defined in [analytics.ts:218](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L218)*
6262

6363
The number of queued events that the analytics client should flush at.
6464

@@ -81,7 +81,7 @@ ___
8181

8282
*Inherited from [Base](analytics.chainedconfiguration.base.md).[ios](analytics.chainedconfiguration.base.md#ios)*
8383

84-
*Defined in analytics.ts:189*
84+
*Defined in [analytics.ts:189](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L189)*
8585

8686
Access iOS specific settings
8787

@@ -94,7 +94,7 @@ ___
9494

9595
**recordScreenViews**(): `this`
9696

97-
*Defined in analytics.ts:202*
97+
*Defined in [analytics.ts:202](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L202)*
9898

9999
Whether the analytics client should automatically make a screen call when a view controller is added to a view hierarchy. Because the iOS underlying implementation uses method swizzling, we recommend initializing the analytics client as early as possible (before any screens are displayed).
100100

@@ -109,7 +109,7 @@ ___
109109

110110
*Inherited from [Base](analytics.chainedconfiguration.base.md).[setup](analytics.chainedconfiguration.base.md#setup)*
111111

112-
*Defined in analytics.ts:185*
112+
*Defined in [analytics.ts:185](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L185)*
113113

114114
Finalize the configuration and initialize the Analytics client.
115115

@@ -128,7 +128,7 @@ ___
128128

129129
**trackAppLifecycleEvents**(): `this`
130130

131-
*Defined in analytics.ts:207*
131+
*Defined in [analytics.ts:207](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L207)*
132132

133133
Enable the automatic tracking of application lifecycle events, such as "Application Installed", "Application Updated" and "Application Opened".
134134

@@ -141,7 +141,7 @@ ___
141141

142142
**trackAttributionData**(): `this`
143143

144-
*Defined in analytics.ts:211*
144+
*Defined in [analytics.ts:211](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L211)*
145145

146146
Whether the analytics client should automatically track attribution data from enabled providers using the mobile service.
147147

@@ -154,7 +154,7 @@ ___
154154

155155
**using**(...integrations: *[Integration](../#integration)[]*): `this`
156156

157-
*Defined in analytics.ts:222*
157+
*Defined in [analytics.ts:222](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L222)*
158158

159159
Register a set of integrations to be used with this Analytics instance.
160160

packages/core/docs/interfaces/analytics.chainedconfiguration.ios.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
*Inherited from [Base](analytics.chainedconfiguration.base.md).[android](analytics.chainedconfiguration.base.md#android)*
3232

33-
*Defined in analytics.ts:193*
33+
*Defined in [analytics.ts:193](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L193)*
3434

3535
Access Android specific settings
3636

@@ -45,7 +45,7 @@ ___
4545

4646
*Inherited from [Base](analytics.chainedconfiguration.base.md).[ios](analytics.chainedconfiguration.base.md#ios)*
4747

48-
*Defined in analytics.ts:189*
48+
*Defined in [analytics.ts:189](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L189)*
4949

5050
Access iOS specific settings
5151

@@ -60,7 +60,7 @@ ___
6060

6161
*Inherited from [Base](analytics.chainedconfiguration.base.md).[setup](analytics.chainedconfiguration.base.md#setup)*
6262

63-
*Defined in analytics.ts:185*
63+
*Defined in [analytics.ts:185](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L185)*
6464

6565
Finalize the configuration and initialize the Analytics client.
6666

@@ -79,7 +79,7 @@ ___
7979

8080
**trackAdvertising**(): `this`
8181

82-
*Defined in analytics.ts:230*
82+
*Defined in [analytics.ts:230](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L230)*
8383

8484
Whether the analytics client should track advertisting info.
8585

@@ -92,7 +92,7 @@ ___
9292

9393
**trackDeepLinks**(): `this`
9494

95-
*Defined in analytics.ts:236*
95+
*Defined in [analytics.ts:236](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L236)*
9696

9797
Whether the analytics client should automatically track deep links.
9898

0 commit comments

Comments
 (0)