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.

interface IFieldSanitizerDetails {
    name: string;
    path: string;
    prop: IEventProperty;
    sanitizer: IValueSanitizer;
    type: FieldValueSanitizerType;
}

Properties

name path prop sanitizer type

Properties

name

name: string

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

path

path: string

The path within the event where the value is stored

prop

prop: IEventProperty

The value for the property.

sanitizer

sanitizer: IValueSanitizer

A reference to the value sanitizer that created the details

type

type: FieldValueSanitizerType

Identifies the type of the property value

Settings

Member Visibility

On This Page

Properties