Class Sanitizer

A class to sanitize HTML strings.

Hierarchy

Sanitizer

Implements

IRenderMime.ISanitizer

Index

Constructors

Properties

_autolink _options

Methods

getAutolink sanitize setAllowedSchemes setAutolink

Constructors

constructor

new Sanitizer(): Sanitizer
Returns Sanitizer

Properties

`Private` _autolink

_autolink: any

`Private` _options

_options: any

Methods

getAutolink

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

sanitize

sanitize(dirty, options?): string
Sanitize an HTML string.
Parameters
- dirty: string
  
  The dirty text.
- Optional options: IRenderMime.ISanitizerOptions
  
  The optional sanitization options.
Returns string
The sanitized string.
Implementation of ISanitizer.sanitize
- Defined in packages/apputils/lib/sanitizer.d.ts:15

setAllowedSchemes

setAllowedSchemes(scheme): void
Set the allowed schemes
Parameters
- scheme: string[]
  
  Allowed schemes
Returns void
- Defined in packages/apputils/lib/sanitizer.d.ts:25

setAutolink

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

Generated using TypeDoc