Class Sanitizer

A class to sanitize HTML strings.

Implements

IRenderMime.ISanitizer

Index

Constructors

Accessors

allowCommandLinker allowNamedProperties

Methods

getAutolink getIncrementalAutolink sanitize setAllowCommandLinker setAllowedSchemes setAllowNamedProperties setAutolink setIncrementalAutolink

Constructors

constructor

new Sanitizer(): Sanitizer
Returns Sanitizer
- Defined in packages/apputils/src/sanitizer.ts:570

Accessors

allowCommandLinker

get allowCommandLinker(): boolean
Returns boolean
Whether to allow command linker attributes.
Implementation of ISanitizer.allowCommandLinker
- Defined in packages/apputils/src/sanitizer.ts:611

allowNamedProperties

get allowNamedProperties(): boolean
Returns boolean
Whether to allow name and id attributes.
Implementation of ISanitizer.allowNamedProperties
- Defined in packages/apputils/src/sanitizer.ts:604

Methods

getAutolink

getAutolink(): boolean
Returns boolean
Whether to replace URLs by HTML anchors.
Implementation of ISanitizer.getAutolink
- Defined in packages/apputils/src/sanitizer.ts:589

getIncrementalAutolink

getIncrementalAutolink(): boolean
Returns boolean
Whether URLs are auto-linked incrementally (asynchronously, across animation frames) rather than in a single synchronous pass.
Implementation of ISanitizer.getIncrementalAutolink
- Defined in packages/apputils/src/sanitizer.ts:597

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.
Implementation of ISanitizer.sanitize
- Defined in packages/apputils/src/sanitizer.ts:582

setAllowCommandLinker

setAllowCommandLinker(allowCommandLinker: boolean): void
Set whether to allow command linker attributes.
Parameters
- allowCommandLinker: boolean
  Whether to allow command linker attributes.
Returns void
- Defined in packages/apputils/src/sanitizer.ts:663

setAllowedSchemes

setAllowedSchemes(scheme: string[]): void
Set the allowed schemes
Parameters
- scheme: string[]
  Allowed schemes. Automatically regenerates sanitizer options to apply the change. Note: the schemes merge into the current config and does not get overwritten.
Returns void
- Defined in packages/apputils/src/sanitizer.ts:622

setAllowNamedProperties

setAllowNamedProperties(allowNamedProperties: boolean): void
Set the whether to allow name and id attributes.
Parameters
- allowNamedProperties: boolean
Returns void
- Defined in packages/apputils/src/sanitizer.ts:653

setAutolink

setAutolink(autolink: boolean): void
Set the URL replacement boolean.
Parameters
- autolink: boolean
  URL replacement boolean.
Returns void
- Defined in packages/apputils/src/sanitizer.ts:633

setIncrementalAutolink

setIncrementalAutolink(incrementalAutolink: boolean): void
Set whether URLs are auto-linked incrementally (asynchronously, across animation frames) rather than in a single synchronous pass.

Disabling this also disables incremental rendering of the text output (it is rendered synchronously in a single blocking pass).
Parameters
- incrementalAutolink: boolean
  Whether to auto-link incrementally.
Returns void
- Defined in packages/apputils/src/sanitizer.ts:646