segments plugin

Load the user's segments

Config

segments: {
  disabled: false,
  storageKey: 'lytics_segments',
  storage: localStorage,
  defaultSegments: ['all']
}

segments.disabled

• Type boolean
• Optional
• Defaults to false

Set disabled to true to disable this plugin.

segments.storageKey

• Type boolean
• Optional
• Defaults to lytics_segments

The key to store the segment list under in the storage.

segments.storage

• Type Storage
• Optional
• Defaults to localStorage

The Storage to use to cache the segment list

segments.defaultSegments

• Type string[]
• Optional
• Defaults to ["all"]

The list of segments to return when the entity is not loaded, and no cached segments are found.

Interfaces

SegmentsCallback

API

loadSegments(callback: SegmentsCallback): void;

parameters

Forcefully load the entity and invoke the callback with the result of calling [getSegments].

getSegments(): string[];

Return the entity's segments, the cached segment list, or config.defaultSegments

examples

jstag.entityReady(() => {
  MyApp.setUserSegments(jstag.getSegments());
});

Exhibit: By using a pattern where the entity is known to be loaded, we are assured that calling getSegments will result in the most accurate list of segments for that user

console.log(jstag.getSegments());

Exhibit: If we're not defensive, we may call getSegments before the entity is loaded, which would result in the config.defaultSegments being returned instead of the more accurate list of segments from the user entity.