src/ngx-segment-analytics.config.ts
Segment Configuration Interface
Properties |
|
apiKey |
apiKey:
|
Type : string
|
Optional |
API Key for Segment.io |
cdnURL |
cdnURL:
|
Type : string
|
Optional |
CDN host if requests are proxied |
debug |
debug:
|
Type : boolean
|
Optional |
Debug mode status |
loadOnInitialization |
loadOnInitialization:
|
Type : boolean
|
Optional |
Load Segment configuration on initialization |
plugins |
plugins:
|
Type : Plugin[]
|
Optional |
Plugins |
segmentHost |
Use cdnURL instead. |
segmentHost:
|
Type : string
|
Optional |
Segment Host if requests are proxied |
segmentUri |
Use cdnURL instead. |
segmentUri:
|
Type : string
|
Optional |
Segment Custom URI @deprecated Use cdnURL instead. |
import {InjectionToken} from '@angular/core';
import type {Plugin} from '@segment/analytics-next';
/**
* Segment Configuration Interface
*/
export interface SegmentConfig {
/** API Key for Segment.io */
apiKey?: string;
/** Debug mode status */
debug?: boolean;
/** Load Segment configuration on initialization */
loadOnInitialization?: boolean;
/**
* Segment Host if requests are proxied
* @deprecated Use cdnURL instead.
**/
segmentHost?: string;
/**
* Segment Custom URI
* @deprecated Use cdnURL instead.
**/
segmentUri?: string;
/** CDN host if requests are proxied */
cdnURL?: string;
/** Plugins **/
plugins?: Plugin[];
}
/** Segment Configuration Injection Token */
export const SEGMENT_CONFIG: InjectionToken<SegmentConfig> = new InjectionToken<SegmentConfig>('ngx-segment-analytics.config');
export const DEFAULT_CONFIG: SegmentConfig = {
debug: false,
loadOnInitialization: true, // Compatibility < 1.2.5
cdnURL: 'https://cdn.segment.com',
segmentHost: 'cdn.segment.com',
segmentUri: '/analytics.js/v1/$API_KEY$/analytics.min.js',
plugins: [],
};