Skip to content

Commit 9426608

Browse files
riley-wvriley-wv
committed
Fix linting errors
1 parent fcdde49 commit 9426608

3 files changed

Lines changed: 43 additions & 76 deletions

File tree

‎packages/posthog/README.md‎

Lines changed: 40 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ In `capacitor.config.json`:
4646
{
4747
"plugins": {
4848
"Posthog": {
49-
"apiKey": 'phc_g8wMenebiIQ1pYd5v9Vy7oakn6MczVKIsNG5ZHCspdy',
50-
"host": 'https://eu.i.posthog.com',
49+
"apiKey": "phc_g8wMenebiIQ1pYd5v9Vy7oakn6MczVKIsNG5ZHCspdy",
50+
"host": "https://eu.i.posthog.com",
5151
"enableSessionReplay": undefined,
5252
"sessionReplayConfig": undefined
5353
}
@@ -149,7 +149,7 @@ const setup = async () => {
149149
await Posthog.setup({
150150
apiKey: 'YOUR_API_KEY',
151151
host: 'https://eu.i.posthog.com',
152-
});
152+
});
153153
};
154154

155155
const unregister = async () => {
@@ -163,24 +163,24 @@ const unregister = async () => {
163163

164164
<docgen-index>
165165

166-
* [`alias(...)`](#alias)
167-
* [`capture(...)`](#capture)
168-
* [`flush()`](#flush)
169-
* [`getFeatureFlag(...)`](#getfeatureflag)
170-
* [`getFeatureFlagPayload(...)`](#getfeatureflagpayload)
171-
* [`group(...)`](#group)
172-
* [`identify(...)`](#identify)
173-
* [`isFeatureEnabled(...)`](#isfeatureenabled)
174-
* [`register(...)`](#register)
175-
* [`reloadFeatureFlags()`](#reloadfeatureflags)
176-
* [`reset()`](#reset)
177-
* [`screen(...)`](#screen)
178-
* [`setup(...)`](#setup)
179-
* [`startSessionRecording()`](#startsessionrecording)
180-
* [`stopSessionRecording()`](#stopsessionrecording)
181-
* [`unregister(...)`](#unregister)
182-
* [Interfaces](#interfaces)
183-
* [Type Aliases](#type-aliases)
166+
- [`alias(...)`](#alias)
167+
- [`capture(...)`](#capture)
168+
- [`flush()`](#flush)
169+
- [`getFeatureFlag(...)`](#getfeatureflag)
170+
- [`getFeatureFlagPayload(...)`](#getfeatureflagpayload)
171+
- [`group(...)`](#group)
172+
- [`identify(...)`](#identify)
173+
- [`isFeatureEnabled(...)`](#isfeatureenabled)
174+
- [`register(...)`](#register)
175+
- [`reloadFeatureFlags()`](#reloadfeatureflags)
176+
- [`reset()`](#reset)
177+
- [`screen(...)`](#screen)
178+
- [`setup(...)`](#setup)
179+
- [`startSessionRecording()`](#startsessionrecording)
180+
- [`stopSessionRecording()`](#stopsessionrecording)
181+
- [`unregister(...)`](#unregister)
182+
- [Interfaces](#interfaces)
183+
- [Type Aliases](#type-aliases)
184184

185185
</docgen-index>
186186

@@ -201,8 +201,7 @@ Assign another distinct ID to the current user.
201201

202202
**Since:** 6.0.0
203203

204-
--------------------
205-
204+
---
206205

207206
### capture(...)
208207

@@ -218,8 +217,7 @@ Capture an event.
218217

219218
**Since:** 6.0.0
220219

221-
--------------------
222-
220+
---
223221

224222
### flush()
225223

@@ -233,8 +231,7 @@ Only available on Android and iOS.
233231

234232
**Since:** 6.0.0
235233

236-
--------------------
237-
234+
---
238235

239236
### getFeatureFlag(...)
240237

@@ -252,8 +249,7 @@ Get the value of a feature flag.
252249

253250
**Since:** 7.0.0
254251

255-
--------------------
256-
252+
---
257253

258254
### getFeatureFlagPayload(...)
259255

@@ -271,8 +267,7 @@ Get the payload of a feature flag.
271267

272268
**Since:** 7.1.0
273269

274-
--------------------
275-
270+
---
276271

277272
### group(...)
278273

@@ -288,8 +283,7 @@ Associate the events for that user with a group.
288283

289284
**Since:** 6.0.0
290285

291-
--------------------
292-
286+
---
293287

294288
### identify(...)
295289

@@ -305,8 +299,7 @@ Identify the current user.
305299

306300
**Since:** 6.0.0
307301

308-
--------------------
309-
302+
---
310303

311304
### isFeatureEnabled(...)
312305

@@ -324,8 +317,7 @@ Check if a feature flag is enabled.
324317

325318
**Since:** 7.0.0
326319

327-
--------------------
328-
320+
---
329321

330322
### register(...)
331323

@@ -341,8 +333,7 @@ Register a new super property. This property will be sent with every event.
341333

342334
**Since:** 6.0.0
343335

344-
--------------------
345-
336+
---
346337

347338
### reloadFeatureFlags()
348339

@@ -354,8 +345,7 @@ Reload the feature flags.
354345

355346
**Since:** 7.0.0
356347

357-
--------------------
358-
348+
---
359349

360350
### reset()
361351

@@ -367,8 +357,7 @@ Reset the current user's ID and anonymous ID.
367357

368358
**Since:** 6.0.0
369359

370-
--------------------
371-
360+
---
372361

373362
### screen(...)
374363

@@ -386,8 +375,7 @@ Only available on Android and iOS.
386375

387376
**Since:** 6.0.0
388377

389-
--------------------
390-
378+
---
391379

392380
### setup(...)
393381

@@ -407,8 +395,7 @@ your Capacitor Configuration file. In this case, you must not call this method.
407395

408396
**Since:** 6.0.0
409397

410-
--------------------
411-
398+
---
412399

413400
### startSessionRecording()
414401

@@ -420,8 +407,7 @@ Start session recording.
420407

421408
**Since:** 7.3.0
422409

423-
--------------------
424-
410+
---
425411

426412
### stopSessionRecording()
427413

@@ -433,8 +419,7 @@ Stop session recording.
433419

434420
**Since:** 7.3.0
435421

436-
--------------------
437-
422+
---
438423

439424
### unregister(...)
440425

@@ -450,55 +435,47 @@ Remove a super property.
450435

451436
**Since:** 6.0.0
452437

453-
--------------------
454-
438+
---
455439

456440
### Interfaces
457441

458-
459442
#### AliasOptions
460443

461444
| Prop | Type | Description | Since |
462445
| ----------- | ------------------- | -------------------------------------------------- | ----- |
463446
| **`alias`** | <code>string</code> | The new distinct ID to assign to the current user. | 6.0.0 |
464447

465-
466448
#### CaptureOptions
467449

468450
| Prop | Type | Description | Since |
469451
| ---------------- | ------------------------------------------------------------ | -------------------------------------- | ----- |
470452
| **`event`** | <code>string</code> | The name of the event to capture. | 6.0.0 |
471453
| **`properties`** | <code><a href="#record">Record</a>&lt;string, any&gt;</code> | The properties to send with the event. | 6.0.0 |
472454

473-
474455
#### GetFeatureFlagResult
475456

476457
| Prop | Type | Description | Since |
477458
| ----------- | -------------------------------------- | -------------------------------------------------------------------------------------------- | ----- |
478459
| **`value`** | <code>string \| boolean \| null</code> | The value of the feature flag. If the feature flag does not exist, the value will be `null`. | 7.0.0 |
479460

480-
481461
#### GetFeatureFlagOptions
482462

483463
| Prop | Type | Description | Since |
484464
| --------- | ------------------- | ---------------------------- | ----- |
485465
| **`key`** | <code>string</code> | The key of the feature flag. | 7.0.0 |
486466

487-
488467
#### GetFeatureFlagPayloadResult
489468

490469
| Prop | Type | Description | Since |
491470
| ----------- | --------------------------------------------- | -------------------------------------- | ----- |
492471
| **`value`** | <code><a href="#jsontype">JsonType</a></code> | The value of the feature flag payload. | 7.1.0 |
493472

494-
495473
#### GetFeatureFlagPayloadOptions
496474

497475
| Prop | Type | Description | Since |
498476
| --------- | ------------------- | ---------------------------- | ----- |
499477
| **`key`** | <code>string</code> | The key of the feature flag. | 7.1.0 |
500478

501-
502479
#### GroupOptions
503480

504481
| Prop | Type | Description | Since |
@@ -507,56 +484,48 @@ Remove a super property.
507484
| **`key`** | <code>string</code> | The group key. | 6.0.0 |
508485
| **`groupProperties`** | <code><a href="#record">Record</a>&lt;string, any&gt;</code> | The properties to send with the group event. | 6.0.0 |
509486

510-
511487
#### IdentifyOptions
512488

513489
| Prop | Type | Description | Since |
514490
| -------------------- | ------------------------------------------------------------ | ----------------------------- | ----- |
515491
| **`distinctId`** | <code>string</code> | The distinct ID of the user. | 6.0.0 |
516492
| **`userProperties`** | <code><a href="#record">Record</a>&lt;string, any&gt;</code> | The person properties to set. | 6.0.0 |
517493

518-
519494
#### IsFeatureEnabledResult
520495

521496
| Prop | Type | Description | Since |
522497
| ------------- | -------------------- | --------------------------------------------------------------------------------------------------- | ----- |
523498
| **`enabled`** | <code>boolean</code> | Whether the feature flag is enabled. If the feature flag does not exist, the value will be `false`. | 7.0.0 |
524499

525-
526500
#### IsFeatureEnabledOptions
527501

528502
| Prop | Type | Description | Since |
529503
| --------- | ------------------- | ---------------------------- | ----- |
530504
| **`key`** | <code>string</code> | The key of the feature flag. | 7.0.0 |
531505

532-
533506
#### RegisterOptions
534507

535508
| Prop | Type | Description | Since |
536509
| ----------- | ------------------- | -------------------------------- | ----- |
537510
| **`key`** | <code>string</code> | The name of the super property. | 6.0.0 |
538511
| **`value`** | <code>any</code> | The value of the super property. | 6.0.0 |
539512

540-
541513
#### ScreenOptions
542514

543515
| Prop | Type | Description | Since |
544516
| ----------------- | ------------------------------------------------------------ | --------------------------------------------- | ----- |
545517
| **`screenTitle`** | <code>string</code> | The name of the screen. | 6.0.0 |
546518
| **`properties`** | <code><a href="#record">Record</a>&lt;string, any&gt;</code> | The properties to send with the screen event. | 6.0.0 |
547519

548-
549520
#### SetupOptions
550521

551522
| Prop | Type | Description | Default | Since |
552523
| ------------------------- | --------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------- | ----- |
553524
| **`apiKey`** | <code>string</code> | The API key of your PostHog project. | | 6.0.0 |
554-
| **`enableErrorTracking`** | <code>boolean</code> | Whether to enable automatic error tracking. | <code>false</code> | 7.3.0 |
555525
| **`enableSessionReplay`** | <code>boolean</code> | Whether to enable session recording automatically. | <code>false</code> | 7.3.0 |
556526
| **`host`** | <code>string</code> | The host of your PostHog instance. | <code>'https://us.i.posthog.com'</code> | 6.0.0 |
557527
| **`sessionReplayConfig`** | <code><a href="#sessionreplayoptions">SessionReplayOptions</a></code> | Session replay configuration options. | | 7.3.0 |
558528

559-
560529
#### SessionReplayOptions
561530

562531
| Prop | Type | Description | Default | Since |
@@ -568,23 +537,21 @@ Remove a super property.
568537
| **`captureNetworkTelemetry`** | <code>boolean</code> | Capture network telemetry in session recordings. | <code>false</code> | 7.3.0 |
569538
| **`debouncerDelay`** | <code>number</code> | Debounce delay for session recording snapshots (in seconds). | <code>1.0</code> | 7.3.0 |
570539

571-
572540
#### UnregisterOptions
573541

574542
| Prop | Type | Description | Since |
575543
| --------- | ------------------- | ----------------------------------------- | ----- |
576544
| **`key`** | <code>string</code> | The name of the super property to remove. | 6.0.0 |
577545

578-
579546
### Type Aliases
580547

581-
582548
#### Record
583549

584550
Construct a type with a set of properties K of type T
585551

586-
<code>{ [P in K]: T; }</code>
587-
552+
<code>{
553+
[P in K]: T;
554+
}</code>
588555

589556
#### JsonType
590557

‎packages/posthog/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,4 @@
9696
"src": "android"
9797
}
9898
}
99-
}
99+
}

‎packages/posthog/src/definitions.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,8 +381,8 @@ export type JsonType =
381381
| boolean
382382
| null
383383
| {
384-
[key: string]: JsonType;
385-
}
384+
[key: string]: JsonType;
385+
}
386386
| JsonType[];
387387

388388
/**

0 commit comments

Comments
 (0)