Interface ISanitizer

An object that handles html sanitization.

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

Implemented by

Sanitizer

Index

Properties

allowCommandLinker? allowNamedProperties?

Methods

getAutolink? getIncrementalAutolink? 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

`Optional`getIncrementalAutolink

getIncrementalAutolink(): boolean
Returns boolean
Whether URLs in large textual outputs are auto-linked incrementally (asynchronously, across animation frames) rather than in a single synchronous pass.

When incremental, the text is shown first and links appear shortly after, keeping the UI responsive; disabling it also disables incremental rendering of the text itself (everything is rendered in one blocking pass, so links appear together with the text at first paint).

When not implemented, incremental auto-linking is assumed.
- Defined in packages/rendermime-interfaces/src/index.ts:433

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:443