Interface IFieldValueSanitizerProvider

This interface is used during the serialization of individual fields when converting the events into envelope (serialized object) which is sent to the services, the format is defined via the Common Schema 4.0 specification. The path and field names used are based on how the data is serialized to the service (CS 4.0 location) and not specifically the location on the event object you pass into the track methods (unless they are the same).

interface IFieldValueSanitizerProvider {
    getSanitizer(path: string, name: string, theType: FieldValueSanitizerType, theKind?: number, propType?: number): FieldValueSanitizerFunc;
    handleField(path: string, name: string): boolean;
}

Methods

getSanitizer handleField

Methods

getSanitizer

handleField

  • handleField(path, name): boolean

  • Does this field value sanitizer handle this path / field combination

    Parameters

    • path: string

      The field path

    • name: string

      The name of the field

    Returns boolean

Settings

Member Visibility

On This Page

Methods