DefinitelyTyped/types/dustjs-linkedin/index.d.ts

// Type definitions for linkedin dustjs 1.2.1
// Project: https://github.com/linkedin/dustjs
// Definitions by: Marcelo Dezem <https://github.com/mdezem>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

//
// Due to a lack of documentation it's not possible
// to know which methods are intended to be public and which 
// are intended to be used internally by the framework.
// All the interfaces definitions here exposes only the methods 
// that are documented in some way (tutorials, guides, references, etc.).
// 
// Fell free to include other methods. If possible let me know about.
//



/**
* A template compiled into a js function.
*/
export interface Template {
    (chk: Chunk, ctx: Context): Chunk;
}

export interface Chunk {
    /**
    * Writes data to this chunk's buffer. 
    */
    write(data: string): Chunk;

    /**
    * Writes data to this chunk's buffer and marks it as flushable. This method must be called on any chunks created via chunk.map. Do not call this method on a handler's main chunk -- dust.render and dust.stream take care of this for you.
    */
    end(data: string): Chunk;

    /**
    * Creates a new chunk and passes it to callback. Use map to wrap asynchronous functions and to partition the template for streaming.
    */
    map(callback: (chunk: Chunk) => any): Chunk;

    /**
    * Convenience method to apply filters to a stream.
    */
    tap(callback: (value: any) => any): Chunk;

    /**
    * Removes the head tap function from the list.
    */
    untap(): Chunk;

    /**
    * Renders a template block, such as a default block or an else block.
    */
    render(body: any, context: Context): Chunk;

    /**
    * Sets an error on this chunk and immediately flushes the output.
    */
    setError(err: any): Chunk;
}

export interface Context {
    /**
    * Retrieves the value at key from the context stack.
    */
    get(key: string): any;

    /**
    * Pushes an arbitrary value onto the context stack and returns a new context instance. Specify index and/or length to enable enumeration helpers.
    */
    push(head: any, idx?: number, len?: number): Context;

    /**
    * Returns a new context instance consisting only of the value at head, plus any previously defined global object.
    */
    rebase(head: any): Context;

    /**
    * Returns the head of the context stack.
    */
    current(): any;
}

export interface Stream {
    flush(): void;
    emit(evt: string, data: any): void;

    /*
    * Registers an event listener. Streams accept a single listener for a given event.
    * @param evt the event. Possible values are data, end, error (maybe more, look in the source).
    */
    on(evt: string, callback: (data?: any) => any): this;

    pipe(stream: Stream): Stream;
}

/**
* register a template into the cache.
* @param name the unique template name. 
* @param tmpl the template function. 
*/
export declare function register(name: string, tmpl: Template): void;

/**
* compile a template body into a string of JavaScript source code
* @param source the template string
* @param name the name used to register the compiled template into the internal cache. See render().
* @strip strip whitespaces from the output. Defaults to false.
*/
export declare function compile(source: string, name: string, strip?: boolean): string;

/**
* Compiles source directly into a JavaScript function that takes a context and an optional callback (see dust.renderSource). Registers the template under [name] if this argument is supplied.
* @param source the template string
* @param name the template name (optional). 
*/
export declare function compileFn(source: string, name?: string): Template;

/**
* Evaluates a compiled source string. 
*/
export declare function loadSource(compiled: string): Template;

/**
* Renders the named template and calls callback on completion.context may be a plain object or an instance of dust.Context.
* @param name the template name.
* @param context a plain object or an instance of dust.Context.
*/
export declare function render(name: string, context: any, callback: (err: any, out: string) => any): void;
export declare function render(name: string, context: Context, callback: (err: any, out: string) => any): void;

/**
* Compiles and renders source, invoking callback on completion. If no callback is supplied this function returns a Stream object. Use this function when precompilation is not required.
* @param source the template string.
* @param context a plain object or an instance of dust.Context.
* @param callback (optional). If supplied the callback will be called passing the result string. If omitted, renderSource() will return a dust.Stream object.
*/
export declare function renderSource(source: string, context: any): Stream;
export declare function renderSource(source: string, context: Context): Stream;
export declare function renderSource(source: string, context: any, callback: (err: any, out: string) => any): void;
export declare function renderSource(source: string, context: Context, callback: (err: any, out: string) => any): void;

/**
* Streams the named template. context may be a plain object or an instance of dust.Context. Returns an instance of dust.Stream.
* @param name the template name.
* @param context a plain object or an instance of dust.Context.
*/
export declare function stream(name: string, context: any): Stream;
export declare function stream(name: string, context: Context): Stream;

/**
* Manufactures a dust.Context instance with its global object set to object.
* @param global a plain object or an instance of dust.Context.
*/
export declare function makeBase(global: any): Context;
export declare function makeBase(global: Context): Context;

export declare function escapeHtml(html: string): string;
export declare function escapeJs(js: string): string;

declare var helpers: {
    [key: string]: (chk: Chunk, ctx: Context, bodies?: any, params?: any) => any;
};

declare var filters: {
    [key: string]: (value: string) => string;
};