typescript-closure-tools/index/closure-library/closure/goog/soy/data.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />
/// <reference path="../i18n/bidi.d.ts" />
/// <reference path="../html/safehtml.d.ts" />

declare module goog.soy.data {

    class SanitizedContent extends SanitizedContent__Class { }
    /** Fake class which should be extended to avoid inheriting static properties */
    class SanitizedContent__Class  { 
    
            /**
             * A string-like object that carries a content-type and a content direction.
             *
             * IMPORTANT! Do not create these directly, nor instantiate the subclasses.
             * Instead, use a trusted, centrally reviewed library as endorsed by your team
             * to generate these objects. Otherwise, you risk accidentally creating
             * SanitizedContent that is attacker-controlled and gets evaluated unescaped in
             * templates.
             *
             * @constructor
             */
            constructor();
    
            /**
             * The context in which this content is safe from XSS attacks.
             * @type {goog.soy.data.SanitizedContentKind}
             */
            contentKind: goog.soy.data.SanitizedContentKind;
    
            /**
             * The content's direction; null if unknown and thus to be estimated when
             * necessary.
             * @type {?goog.i18n.bidi.Dir}
             */
            contentDir: goog.i18n.bidi.Dir;
    
            /**
             * The already-safe content.
             * @type {string}
             */
            content: string;
    
            /**
             * Converts sanitized content of kind TEXT or HTML into SafeHtml. HTML content
             * is converted without modification, while text content is HTML-escaped.
             * @return {!goog.html.SafeHtml}
             * @throws {Error} when the content kind is not TEXT or HTML.
             */
            toSafeHtml(): goog.html.SafeHtml;
    } 
    

    /**
     * A type of textual content.
     *
     * This is an enum of type Object so that these values are unforgeable.
     *
     * @enum {!Object}
     */
    enum SanitizedContentKind { HTML, JS, JS_STR_CHARS, URI, ATTRIBUTES, CSS, TEXT } 
}