Class Sanitizer

A class to sanitize HTML strings.

Implements

IRenderMime.ISanitizer

Index

Constructors

Accessors

allowNamedProperties

Methods

getAutolink sanitize setAllowedSchemes setAllowNamedProperties setAutolink

Constructors

constructor

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

Accessors

allowNamedProperties

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

Methods

getAutolink

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

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

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

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

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