Options
All
  • Public
  • Public/Protected
  • All
Menu

xss

author

Zongmin Leileizongmin@gmail.com

Index

Type aliases

EscapeHandler

EscapeHandler: EscapeHandler

OnTagAttrHandler

OnTagAttrHandler: OnTagAttrHandler

OnTagHandler

OnTagHandler: OnTagHandler

SafeAttrValueHandler

SafeAttrValueHandler: SafeAttrValueHandler

Variables

cssFilter

cssFilter: ICSSFilter

whiteList

whiteList: IWhiteList

Functions

StripTagBody

  • StripTagBody(tags: string[], next: () => void): { onIgnoreTag: any; remove: any }
  • Parameters

    • tags: string[]
    • next: () => void
        • (): void
        • Returns void

    Returns { onIgnoreTag: any; remove: any }

    • onIgnoreTag:function
      • onIgnoreTag(tag: string, html: string, options: { isClosing: boolean; position: number }): string
      • Parameters

        • tag: string
        • html: string
        • options: { isClosing: boolean; position: number }
          • isClosing: boolean
          • position: number

        Returns string

    • remove:function
      • remove(html: string): string
      • Parameters

        • html: string

        Returns string

Const clearNonPrintableCharacter

  • clearNonPrintableCharacter(str: string): string
  • Parameters

    • str: string

    Returns string

Const default

Const escapeAttrValue

  • escapeAttrValue(str: string): string
  • Parameters

    • str: string

    Returns string

Const escapeDangerHtml5Entities

  • escapeDangerHtml5Entities(str: string): string
  • Parameters

    • str: string

    Returns string

Const escapeHtml

  • escapeHtml(str: string): string
  • Parameters

    • str: string

    Returns string

Const escapeHtmlEntities

  • escapeHtmlEntities(str: string): string
  • Parameters

    • str: string

    Returns string

Const escapeQuote

  • escapeQuote(str: string): string
  • Parameters

    • str: string

    Returns string

filterXSS

Const friendlyAttrValue

  • friendlyAttrValue(str: string): string
  • Parameters

    • str: string

    Returns string

getDefaultCSSWhiteList

getDefaultWhiteList

Const onIgnoreTag

  • onIgnoreTag(tag: string, html: string, options: { isClosing?: boolean; isWhite?: boolean; position?: number; sourcePosition?: number }): string | void
  • Parameters

    • tag: string
    • html: string
    • options: { isClosing?: boolean; isWhite?: boolean; position?: number; sourcePosition?: number }
      • Optional isClosing?: boolean
      • Optional isWhite?: boolean
      • Optional position?: number
      • Optional sourcePosition?: number

    Returns string | void

Const onIgnoreTagAttr

  • onIgnoreTagAttr(tag: string, name: string, value: string, isWhiteAttr: boolean): string | void
  • Parameters

    • tag: string
    • name: string
    • value: string
    • isWhiteAttr: boolean

    Returns string | void

onIgnoreTagStripAll

  • onIgnoreTagStripAll(): string
  • Returns string

Const onTag

  • onTag(tag: string, html: string, options: { isClosing?: boolean; isWhite?: boolean; position?: number; sourcePosition?: number }): string | void
  • Parameters

    • tag: string
    • html: string
    • options: { isClosing?: boolean; isWhite?: boolean; position?: number; sourcePosition?: number }
      • Optional isClosing?: boolean
      • Optional isWhite?: boolean
      • Optional position?: number
      • Optional sourcePosition?: number

    Returns string | void

Const onTagAttr

  • onTagAttr(tag: string, name: string, value: string, isWhiteAttr: boolean): string | void
  • Parameters

    • tag: string
    • name: string
    • value: string
    • isWhiteAttr: boolean

    Returns string | void

parseAttr

  • parseAttr(html: string, onAttr: (name: string, value: string) => string): string
  • Parameters

    • html: string
    • onAttr: (name: string, value: string) => string
        • (name: string, value: string): string
        • Parameters

          • name: string
          • value: string

          Returns string

    Returns string

parseTag

  • parseTag(html: string, onTag: (sourcePosition: number, position: number, tag: string, html: string, isClosing: boolean) => string, escapeHtml: EscapeHandler): string
  • Parameters

    • html: string
    • onTag: (sourcePosition: number, position: number, tag: string, html: string, isClosing: boolean) => string
        • (sourcePosition: number, position: number, tag: string, html: string, isClosing: boolean): string
        • Parameters

          • sourcePosition: number
          • position: number
          • tag: string
          • html: string
          • isClosing: boolean

          Returns string

    • escapeHtml: EscapeHandler

    Returns string

Const safeAttrValue

  • safeAttrValue(tag: string, name: string, value: string, cssFilter: ICSSFilter): string
  • Parameters

    • tag: string
    • name: string
    • value: string
    • cssFilter: ICSSFilter

    Returns string

Const stripBlankChar

  • stripBlankChar(str: string): string
  • Parameters

    • str: string

    Returns string

Const stripCommentTag

  • stripCommentTag(str: string): string
  • Parameters

    • str: string

    Returns string

Const unescapeQuote

  • unescapeQuote(str: string): string
  • Parameters

    • str: string

    Returns string

Generated using TypeDoc