Interface IFieldSanitizerDetails

This interface defines the object that is passed to any provided FieldValueSanitizerFunc, it provides not only the value to be sanitized but also some context about the value like it's location within the envelope (serialized object), the format is defined via the Common Schema 4.0 specification.

Hierarchy

  • IFieldSanitizerDetails

Properties

Properties

name: string

The name of the field with the event path that will store the value

path: string

The path within the event where the value is stored

The value for the property.

sanitizer: IValueSanitizer

A reference to the value sanitizer that created the details

Identifies the type of the property value

Generated using TypeDoc