mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-12 21:10:23 +00:00
Rework the structure of the type-definition
This commit is contained in:
Manuel Thalmann
Vendored
+144
-165
@@ -3,144 +3,6 @@
|
||||
// Definitions by: Mark Ashley Bell <https://github.com/markashleybell>, Manuel Thalmann <https://github.com/manuth>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
/**
|
||||
* A simple string scanner that is used by the template parser to find tokens in template strings.
|
||||
*/
|
||||
interface MustacheScanner {
|
||||
string: string;
|
||||
tail: string;
|
||||
pos: number;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheScanner` class.
|
||||
*/
|
||||
new(string: string): MustacheScanner;
|
||||
|
||||
/**
|
||||
* Returns `true` if the tail is empty (end of string).
|
||||
*/
|
||||
eos(): boolean;
|
||||
|
||||
/**
|
||||
* Tries to match the given regular expression at the current position.
|
||||
*
|
||||
* @param re
|
||||
* The regex-pattern to match.
|
||||
*
|
||||
* @returns
|
||||
* The matched text if it can match, the empty string otherwise.
|
||||
*/
|
||||
scan(re: RegExp): string;
|
||||
|
||||
/**
|
||||
* Skips all text until the given regular expression can be matched.
|
||||
*
|
||||
* @param re
|
||||
* The regex-pattern to match.
|
||||
*
|
||||
* @returns
|
||||
* Returns the skipped string, which is the entire tail if no match can be made.
|
||||
*/
|
||||
scanUntil(re: RegExp): string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a rendering context by wrapping a view object and maintaining a reference to the parent context.
|
||||
*/
|
||||
interface MustacheContext {
|
||||
view: any;
|
||||
parentContext: MustacheContext;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheContenxt` class.
|
||||
*/
|
||||
new(view: any, parentContext: MustacheContext): MustacheContext;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheContenxt` class.
|
||||
*/
|
||||
new(view: any): MustacheContext;
|
||||
|
||||
/**
|
||||
* Creates a new context using the given view with this context as the parent.
|
||||
*
|
||||
* @param view
|
||||
* The view to create the new context with.
|
||||
*/
|
||||
push(view: any): MustacheContext;
|
||||
|
||||
/**
|
||||
* Returns the value of the given name in this context, traversing up the context hierarchy if the value is absent in this context's view.
|
||||
*
|
||||
* @param name
|
||||
* The name to look up.
|
||||
*/
|
||||
lookup(name: string): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* A Writer knows how to take a stream of tokens and render them to a `string`, given a context.
|
||||
*
|
||||
* It also maintains a cache of templates to avoid the need to parse the same template twice.
|
||||
*/
|
||||
interface MustacheWriter {
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheWriter` class.
|
||||
*/
|
||||
new(): MustacheWriter;
|
||||
|
||||
/**
|
||||
* Clears all cached templates in this writer.
|
||||
*/
|
||||
clearCache(): void;
|
||||
|
||||
/**
|
||||
* Parses and caches the given `template` and returns the array of tokens that is generated from the parse.
|
||||
*
|
||||
* @param template
|
||||
* The template to parse.
|
||||
*/
|
||||
parse(template: string, tags?: any): any;
|
||||
|
||||
/**
|
||||
* High-level method that is used to render the given `template` with the given `view`.
|
||||
*
|
||||
* @param template
|
||||
* The template to render.
|
||||
*
|
||||
* @param view
|
||||
* The view to render the template with.
|
||||
*
|
||||
* @param partials
|
||||
* Either an object that contains the names and templates of partials that are used in a template
|
||||
*
|
||||
* -- or --
|
||||
*
|
||||
* A function that is used to load partial template on the fly that takes a single argument: the name of the partial.
|
||||
*/
|
||||
render(template: string, view: any | MustacheContext, partials: any): string;
|
||||
|
||||
/**
|
||||
* Low-level method that renders the given array of `tokens` using the given `context` and `partials`.
|
||||
*
|
||||
* @param tokens
|
||||
* The tokens to render.
|
||||
*
|
||||
* @param context
|
||||
* The context to use for rendering the tokens.
|
||||
*
|
||||
* @param partials
|
||||
* The partials to use for rendering the tokens.
|
||||
*
|
||||
* @param originalTemplate
|
||||
* An object used to extract the portion of the original template that was contained in a higher-order section.
|
||||
*
|
||||
* If the template doesn't use higher-order sections, this argument may be omitted.
|
||||
*/
|
||||
renderTokens(tokens: string[], context: MustacheContext, partials: any, originalTemplate: any): string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides the functionality to render templates with `{{mustaches}}`.
|
||||
*/
|
||||
@@ -160,23 +22,6 @@ interface MustacheStatic {
|
||||
*/
|
||||
tags: string;
|
||||
|
||||
/**
|
||||
* A simple string scanner that is used by the template parser to find tokens in template strings.
|
||||
*/
|
||||
Scanner: MustacheScanner;
|
||||
|
||||
/**
|
||||
* Represents a rendering context by wrapping a view object and maintaining a reference to the parent context.
|
||||
*/
|
||||
Context: MustacheContext;
|
||||
|
||||
/**
|
||||
* A Writer knows how to take a stream of tokens and render them to a `string`, given a context.
|
||||
*
|
||||
* It also maintains a cache of templates to avoid the need to parse the same template twice.
|
||||
*/
|
||||
Writer: MustacheWriter;
|
||||
|
||||
/**
|
||||
* Escapes HTML-characters.
|
||||
*
|
||||
@@ -188,7 +33,7 @@ interface MustacheStatic {
|
||||
/**
|
||||
* Clears all cached templates in this writer.
|
||||
*/
|
||||
clearCache(): MustacheWriter;
|
||||
clearCache(): void;
|
||||
|
||||
/**
|
||||
* Parses and caches the given template in the default writer and returns the array of tokens it contains.
|
||||
@@ -219,7 +64,7 @@ interface MustacheStatic {
|
||||
*
|
||||
* A function that is used to load partial template on the fly that takes a single argument: the name of the partial.
|
||||
*/
|
||||
render(template: string, view: any | MustacheContext, partials?: any): string;
|
||||
render(template: string, view: any | Mustache.Context, partials?: any): string;
|
||||
|
||||
/**
|
||||
* Renders the `template` with the given `view` and `partials` using the default writer.
|
||||
@@ -237,14 +82,148 @@ interface MustacheStatic {
|
||||
*
|
||||
* A function that is used to load partial template on the fly that takes a single argument: the name of the partial.
|
||||
*/
|
||||
to_html(template: string, view: any | MustacheContext, partials?: any, send?: any): any;
|
||||
to_html(template: string, view: any | Mustache.Context, partials?: any, send?: any): any;
|
||||
}
|
||||
|
||||
declare namespace Mustache {
|
||||
/**
|
||||
* A simple string scanner that is used by the template parser to find tokens in template strings.
|
||||
*/
|
||||
export class Scanner {
|
||||
string: string;
|
||||
tail: string;
|
||||
pos: number;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheScanner` class.
|
||||
*/
|
||||
constructor(string: string);
|
||||
|
||||
/**
|
||||
* Returns `true` if the tail is empty (end of string).
|
||||
*/
|
||||
eos(): boolean;
|
||||
|
||||
/**
|
||||
* Tries to match the given regular expression at the current position.
|
||||
*
|
||||
* @param re
|
||||
* The regex-pattern to match.
|
||||
*
|
||||
* @returns
|
||||
* The matched text if it can match, the empty string otherwise.
|
||||
*/
|
||||
scan(re: RegExp): string;
|
||||
|
||||
/**
|
||||
* Skips all text until the given regular expression can be matched.
|
||||
*
|
||||
* @param re
|
||||
* The regex-pattern to match.
|
||||
*
|
||||
* @returns
|
||||
* Returns the skipped string, which is the entire tail if no match can be made.
|
||||
*/
|
||||
scanUntil(re: RegExp): string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a rendering context by wrapping a view object and maintaining a reference to the parent context.
|
||||
*/
|
||||
export class Context {
|
||||
view: any;
|
||||
parentContext: Context;
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheContenxt` class.
|
||||
*/
|
||||
constructor(view: any, parentContext: Context);
|
||||
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheContenxt` class.
|
||||
*/
|
||||
constructor(view: any);
|
||||
|
||||
/**
|
||||
* Creates a new context using the given view with this context as the parent.
|
||||
*
|
||||
* @param view
|
||||
* The view to create the new context with.
|
||||
*/
|
||||
push(view: any): Context;
|
||||
|
||||
/**
|
||||
* Returns the value of the given name in this context, traversing up the context hierarchy if the value is absent in this context's view.
|
||||
*
|
||||
* @param name
|
||||
* The name to look up.
|
||||
*/
|
||||
lookup(name: string): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* A Writer knows how to take a stream of tokens and render them to a `string`, given a context.
|
||||
*
|
||||
* It also maintains a cache of templates to avoid the need to parse the same template twice.
|
||||
*/
|
||||
export class Writer {
|
||||
/**
|
||||
* Initializes a new instance of the `MustacheWriter` class.
|
||||
*/
|
||||
constructor();
|
||||
|
||||
/**
|
||||
* Clears all cached templates in this writer.
|
||||
*/
|
||||
clearCache(): void;
|
||||
|
||||
/**
|
||||
* Parses and caches the given `template` and returns the array of tokens that is generated from the parse.
|
||||
*
|
||||
* @param template
|
||||
* The template to parse.
|
||||
*/
|
||||
parse(template: string, tags?: any): any;
|
||||
|
||||
/**
|
||||
* High-level method that is used to render the given `template` with the given `view`.
|
||||
*
|
||||
* @param template
|
||||
* The template to render.
|
||||
*
|
||||
* @param view
|
||||
* The view to render the template with.
|
||||
*
|
||||
* @param partials
|
||||
* Either an object that contains the names and templates of partials that are used in a template
|
||||
*
|
||||
* -- or --
|
||||
*
|
||||
* A function that is used to load partial template on the fly that takes a single argument: the name of the partial.
|
||||
*/
|
||||
render(template: string, view: any | Context, partials: any): string;
|
||||
|
||||
/**
|
||||
* Low-level method that renders the given array of `tokens` using the given `context` and `partials`.
|
||||
*
|
||||
* @param tokens
|
||||
* The tokens to render.
|
||||
*
|
||||
* @param context
|
||||
* The context to use for rendering the tokens.
|
||||
*
|
||||
* @param partials
|
||||
* The partials to use for rendering the tokens.
|
||||
*
|
||||
* @param originalTemplate
|
||||
* An object used to extract the portion of the original template that was contained in a higher-order section.
|
||||
*
|
||||
* If the template doesn't use higher-order sections, this argument may be omitted.
|
||||
*/
|
||||
renderTokens(tokens: string[], context: Context, partials: any, originalTemplate: any): string;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides the functionality to render templates with `{{mustaches}}`.
|
||||
*/
|
||||
declare var Mustache: MustacheStatic;
|
||||
|
||||
declare module 'mustache' {
|
||||
export = Mustache;
|
||||
}
|
||||
export = Mustache;
|
||||
export as namespace Mustache;
|
||||
Reference in New Issue
Block a user