wassname/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/wassname/DefinitelyTyped.git synced 2026-08-20 12:00:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5542 from bazuzi/update-dompurify

Browse Source 
Expand typings for DOMPurify
This commit is contained in:
Horiuchi_H
2015-08-26 14:48:19 +09:00
parent eb835aa72f 5b053a7579
commit fa8d9683f3
2 changed files with 70 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dompurify/dompurify-tests.ts
+49
View File
@@ -6,3 +6,52 @@ dompurify.sanitize('<script>alert("hi")</script>');
dompurify.addHook('beforeSanitizeElements', (el, data, config) => {
return el;
});
//examples from the DOMPurify README
let dirty = '<script>alert("hi")</script><p>Totally safe<p><p onerror="blowUp()">Totally not safe</p>';
// allow only <b>
dompurify.sanitize(dirty, {ALLOWED_TAGS: ['b']});
// allow only <b> and <q> with style attributes (for whatever reason)
dompurify.sanitize(dirty, {ALLOWED_TAGS: ['b', 'q'], ALLOWED_ATTR: ['style']});
// leave all as it is but forbid <style>
dompurify.sanitize(dirty, {FORBID_TAGS: ['style']});
// leave all as it is but forbid style attributes
dompurify.sanitize(dirty, {FORBID_ATTR: ['style']});
// extend the existing array of allowed tags
dompurify.sanitize(dirty, {ADD_TAGS: ['my-tag']});
// extend the existing array of attributes
dompurify.sanitize(dirty, {ADD_ATTR: ['my-attr']});
// prohibit HTML5 data attributes (default is true)
dompurify.sanitize(dirty, {ALLOW_DATA_ATTR: false});
// return a DOM HTMLBodyElement instead of an HTML string (default is false)
dompurify.sanitize(dirty, {RETURN_DOM: true});
// return a DOM DocumentFragment instead of an HTML string (default is false)
dompurify.sanitize(dirty, {RETURN_DOM_FRAGMENT: true});
// return a DOM DocumentFragment instead of an HTML string (default is false)
// also import it into the current document (default is false).
// RETURN_DOM_IMPORT must be set if you would like to append
// the returned node to the current document
let clean = dompurify.sanitize(dirty, {RETURN_DOM_FRAGMENT: true, RETURN_DOM_IMPORT: true});
document.body.appendChild(clean);
// return entire document including <html> tags (default is false)
dompurify.sanitize(dirty, {WHOLE_DOCUMENT: true});
// make output safe for usage in jQuery's $()/html() method (default is false)
dompurify.sanitize(dirty, {SAFE_FOR_JQUERY: true});
// disable DOM Clobbering protection on output (default is true, handle with care!)
dompurify.sanitize(dirty, {SANITIZE_DOM: false});
// discard an element's content when the element is removed (default is true)
dompurify.sanitize(dirty, {KEEP_CONTENT: false});
dompurify/dompurify.d.ts
Vendored
+21 -2
View File
@@ -1,11 +1,30 @@
// Type definitions for DOM Purify
// Project: https://github.com/cure53/DOMPurify
// Definitions by: Dave Taylor <http://davetayls.me>
// Definitions by: Dave Taylor <http://davetayls.me>, Samira Bazuzi <https://github.com/bazuzi>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
interface IDOMPurify {
sanitize(s:string):string;
addHook(hook:string, cb:(currentNode:Element, data:any, config:any) => Element):void;
sanitize(s:string, config:IDOMPurifyConfig):any;
addHook(hook:string, cb:(currentNode:Element, data:any, config:IDOMPurifyConfig) => Element):void;
}
interface IDOMPurifyConfig {
ADD_ATTR?:string[];
ADD_TAGS?:string[];
ALLOW_DATA_ATTR?:boolean;
ALLOWED_ATTR?:string[];
ALLOWED_TAGS?:string[];
FORBID_ATTR?:string[];
FORBID_TAGS?:string[];
KEEP_CONTENT?:boolean;
RETURN_DOM?:boolean;
RETURN_DOM_FRAGMENT?:boolean;
RETURN_DOM_IMPORT?:boolean;
SAFE_FOR_JQUERY?:boolean;
SANITIZE_DOM?:boolean;
WHOLE_DOCUMENT?:boolean;
}
declare var DOMPurify:IDOMPurify;