Skip to content

Commit 8554a5e

Browse files
committed
Update JSDoc
1 parent 87aa949 commit 8554a5e

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

projects/pixel/src/lib/pixel.models.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ export interface PixelEventProperties {
5555

5656
/**
5757
* The currency for the `value` specified.
58-
* @see {@link https://developers.facebook.com/docs/marketing-api/currencies}
58+
*
59+
* See {@link https://developers.facebook.com/docs/marketing-api/currencies Facebook Pixel docs - currency codes}
5960
*/
6061
currency?:
6162
'AED' | 'ARS' | 'AUD' |

projects/pixel/src/lib/pixel.module.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export class PixelModule {
1212

1313
constructor( private pixel: PixelService ) {
1414
if (!PixelModule.config) {
15-
throw Error('ngx-pixel not configured correctly');
15+
throw Error('ngx-pixel not configured correctly. Pass the `pixelId` property to the `forRoot()` function');
1616
}
1717
if (PixelModule.config.enabled) {
1818
this.pixel.initialize();

projects/pixel/src/lib/pixel.service.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ export class PixelService {
5050

5151
/**
5252
* Track a Standard Event as predefined by Facebook
53-
* @see {@link https://developers.facebook.com/docs/facebook-pixel/reference}
53+
*
54+
* See {@link https://developers.facebook.com/docs/facebook-pixel/reference Facebook Pixel docs - reference}
5455
* @param eventName The name of the event that is being tracked
5556
* @param properties Optional properties of the event
5657
*/
@@ -69,7 +70,8 @@ export class PixelService {
6970

7071
/**
7172
* Track a custom Event
72-
* @see {@link https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking#custom-conversions}
73+
*
74+
* See {@link https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking#custom-conversions Facebook Pixel docs - custom conversions}
7375
* @param eventName The name of the event that is being tracked
7476
* @param properties Optional properties of the event
7577
*/

0 commit comments

Comments
 (0)