Interface ISegmentGroupClass

Interface for evaluating if a context matches a segment.

interface ISegmentGroupClass {
    segmentName: string;
    getIsGlobal(): boolean;
    getSegmentData(): ISegmentGroup;
    userInGroup(ctx: GeneralContext): boolean;
}

Implemented by

SegmentGroup

Index

Properties

Methods

getIsGlobal getSegmentData userInGroup

Properties

segmentName

segmentName: string

Name of the segment.

Methods

getIsGlobal

getIsGlobal(): boolean
Checks if segment data is global.

Returns boolean
- Defined in types.ts:243

getSegmentData

getSegmentData(): ISegmentGroup
Retrieves the raw segment configuration.

Returns ISegmentGroup
- Defined in types.ts:245

userInGroup

userInGroup(ctx: GeneralContext): boolean
Checks if the given context belongs to this segment.
Parameters
- ctx: GeneralContext
Returns boolean
- Defined in types.ts:241