Skip to content

Commit 93742f3

Browse files
emademad
authored andcommitted
docs(context): revert auto changes
1 parent b600f70 commit 93742f3

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

packages/core/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
**Ƭ Integration**: *`function` \| `object`*
2626

27-
*Defined in [analytics.ts:8](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L8)*
27+
*Defined in [analytics.ts:8](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L8)*
2828

2929
___
3030

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
**● ready**: *`false`* = false
4141

42-
*Defined in [analytics.ts:96](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L96)*
42+
*Defined in [analytics.ts:96](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L96)*
4343

4444
Whether the client is ready to send events to Segment.
4545

@@ -55,7 +55,7 @@ ___
5555

5656
**alias**(newId: *`string`*, options?: *[Options]()*): `Promise`<`void`>
5757

58-
*Defined in [analytics.ts:266](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L266)*
58+
*Defined in [analytics.ts:266](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L266)*
5959

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

@@ -77,7 +77,7 @@ ___
7777

7878
**catch**(handler: *[ErrorHandler]()*): `this`
7979

80-
*Defined in [analytics.ts:111](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L111)*
80+
*Defined in [analytics.ts:111](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L111)*
8181

8282
Catch React-Native bridge errors
8383

@@ -98,7 +98,7 @@ ___
9898

9999
**disable**(): `Promise`<`void`>
100100

101-
*Defined in [analytics.ts:305](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L305)*
101+
*Defined in [analytics.ts:305](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L305)*
102102

103103
Completely disable the sending of any analytics data.
104104

@@ -113,7 +113,7 @@ ___
113113

114114
**enable**(): `Promise`<`void`>
115115

116-
*Defined in [analytics.ts:295](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L295)*
116+
*Defined in [analytics.ts:295](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L295)*
117117

118118
Enable the sending of analytics data. Enabled by default.
119119

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

129129
**flush**(): `Promise`<`void`>
130130

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

133133
Trigger an upload of all queued events.
134134

@@ -143,7 +143,7 @@ ___
143143

144144
**getAnonymousId**(): `Promise`<`string`>
145145

146-
*Defined in [analytics.ts:310](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L310)*
146+
*Defined in [analytics.ts:310](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L310)*
147147

148148
Retrieve the anonymousId.
149149

@@ -156,7 +156,7 @@ ___
156156

157157
**group**(groupId: *`string`*, traits?: *[JsonMap]()*, options?: *[Options]()*): `Promise`<`void`>
158158

159-
*Defined in [analytics.ts:253](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L253)*
159+
*Defined in [analytics.ts:253](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L253)*
160160

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

@@ -179,7 +179,7 @@ ___
179179

180180
**identify**(user: *`string`*, traits?: *[JsonMap]()*, options?: *[Options]()*): `Promise`<`void`>
181181

182-
*Defined in [analytics.ts:240](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L240)*
182+
*Defined in [analytics.ts:240](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L240)*
183183

184184
Associate a user with their unique ID and record traits about them.
185185

@@ -202,7 +202,7 @@ ___
202202

203203
**middleware**(middleware: *[Middleware]()*): `this`
204204

205-
*Defined in [analytics.ts:149](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L149)*
205+
*Defined in [analytics.ts:149](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L149)*
206206

207207
Append a new middleware to the middleware chain.
208208

@@ -240,7 +240,7 @@ ___
240240

241241
**reset**(): `Promise`<`void`>
242242

243-
*Defined in [analytics.ts:276](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L276)*
243+
*Defined in [analytics.ts:276](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L276)*
244244

245245
Reset any user state that is cached on the device.
246246

@@ -255,7 +255,7 @@ ___
255255

256256
**screen**(name: *`string`*, properties?: *[JsonMap]()*, options?: *[Options]()*): `Promise`<`void`>
257257

258-
*Defined in [analytics.ts:225](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L225)*
258+
*Defined in [analytics.ts:225](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L225)*
259259

260260
Record the screens or views your users see.
261261

@@ -278,7 +278,7 @@ ___
278278

279279
**setup**(writeKey: *`string`*, configuration?: *[Configuration](../interfaces/analytics.configuration.md)*): `Promise`<`void`>
280280

281-
*Defined in [analytics.ts:188](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L188)*
281+
*Defined in [analytics.ts:188](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L188)*
282282

283283
Setup the Analytics module. All calls made before are queued and only executed if the configuration was successful.
284284

@@ -308,7 +308,7 @@ ___
308308

309309
**track**(event: *`string`*, properties?: *[JsonMap]()*, options?: *[Options]()*): `Promise`<`void`>
310310

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

313313
Record the actions your users perform.
314314

@@ -331,7 +331,7 @@ ___
331331

332332
**useNativeConfiguration**(): `this`
333333

334-
*Defined in [analytics.ts:161](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L161)*
334+
*Defined in [analytics.ts:161](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L161)*
335335

336336
Use the native configuration.
337337

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

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

3030
**● android**: *`undefined` \| `object`*
3131

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

3434
Android specific settings.
3535

@@ -40,7 +40,7 @@ ___
4040

4141
**● debug**: *`undefined` \| `false` \| `true`*
4242

43-
*Defined in [analytics.ts:38](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L38)*
43+
*Defined in [analytics.ts:38](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L38)*
4444

4545
___
4646
<a id="flushat"></a>
@@ -49,7 +49,7 @@ ___
4949

5050
**● flushAt**: *`undefined` \| `number`*
5151

52-
*Defined in [analytics.ts:46](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L46)*
52+
*Defined in [analytics.ts:46](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L46)*
5353

5454
The number of queued events that the analytics client should flush at. Setting this to `1` will not queue any events and will use more battery.
5555

@@ -62,7 +62,7 @@ ___
6262

6363
**● ios**: *`undefined` \| `object`*
6464

65-
*Defined in [analytics.ts:51](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L51)*
65+
*Defined in [analytics.ts:51](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L51)*
6666

6767
iOS specific settings.
6868

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

7474
**● recordScreenViews**: *`undefined` \| `false` \| `true`*
7575

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

7878
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.
7979

@@ -86,7 +86,7 @@ ___
8686

8787
**● trackAppLifecycleEvents**: *`undefined` \| `false` \| `true`*
8888

89-
*Defined in [analytics.ts:26](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L26)*
89+
*Defined in [analytics.ts:26](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L26)*
9090

9191
Whether the analytics client should automatically track application lifecycle events, such as "Application Installed", "Application Updated" and "Application Opened".
9292

@@ -99,7 +99,7 @@ ___
9999

100100
**● trackAttributionData**: *`undefined` \| `false` \| `true`*
101101

102-
*Defined in [analytics.ts:32](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L32)*
102+
*Defined in [analytics.ts:32](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L32)*
103103

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

@@ -112,7 +112,7 @@ ___
112112

113113
**● using**: *[Integration](../#integration)[]*
114114

115-
*Defined in [analytics.ts:37](https://github.com/emadgit/analytics-react-native/blob/master/packages/core/src/analytics.ts#L37)*
115+
*Defined in [analytics.ts:37](https://github.com/segmentio/analytics-react-native/blob/master/packages/core/src/analytics.ts#L37)*
116116

117117
Register a set of integrations to be used with this Analytics instance.
118118

0 commit comments

Comments
 (0)