Interface ISanitizer

An object that handles html sanitization.

interface ISanitizer {
    allowCommandLinker?: boolean;
    allowNamedProperties?: boolean;
    getAutolink(): boolean;
    sanitize(dirty: string, options?: IRenderMime.ISanitizerOptions): string;
}

Implemented by

Sanitizer

Index

Properties

allowCommandLinker? allowNamedProperties?

Methods

getAutolink? sanitize

Properties

`Optional` `Readonly`allowCommandLinker

allowCommandLinker?: boolean

Returns

Whether to allow command linker attributes.

`Optional` `Readonly`allowNamedProperties

allowNamedProperties?: boolean

Returns

Whether to allow name and id properties.

Methods

`Optional`getAutolink

getAutolink(): boolean
Returns boolean
Whether to replace URLs by HTML anchors.
- Defined in packages/rendermime-interfaces/src/index.ts:419

sanitize

sanitize(dirty: string, options?: IRenderMime.ISanitizerOptions): string
Sanitize an HTML string.
Parameters
- dirty: string
  The dirty text.
- Optionaloptions: IRenderMime.ISanitizerOptions
  The optional sanitization options.
Returns string
The sanitized string.
- Defined in packages/rendermime-interfaces/src/index.ts:429