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).

Hierarchy

  • IFieldValueSanitizerProvider

Methods

  • Get the field sanitizer for this type of field based on the field type, value kind and/or event property type

    Parameters

    • path: string

      The field path

    • name: string

      The name of the field

    • theType: FieldValueSanitizerType

      The type of field

    • Optional theKind: number

      The value kind of the field

    • Optional propType: number

      The property type of the field

    Returns FieldValueSanitizerFunc

  • 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

Generated using TypeDoc