Skip to content

Commit

Permalink
Removing the rtype API definitions from README
Browse files Browse the repository at this point in the history
Primarily because [rtype](https://github.com/ericelliott/rtype) seems to
be a stalled project that hasn't gotten updated for 4 years.

Similar more up-to-date definitions can be found in the
TypeScript definitions: [@types/mustache](https://www.npmjs.com/package/@types/mustache).
  • Loading branch information
phillipj committed Jan 11, 2020
1 parent bd742d5 commit c41045b
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions README.md
Expand Up @@ -106,29 +106,6 @@ var output = Mustache.render("{{title}} spends {{calc}}", view);

In this example, the `Mustache.render` function takes two parameters: 1) the [mustache](http://mustache.github.com/) template and 2) a `view` object that contains the data and code needed to render the template.

## API

Following is an [rtype](https://git.io/rtype) signature of the most commonly used functions.

```js
Mustache.render(
template : String,
view : Object,
partials? : Object,
tags = ['{{', '}}'] : Tags,
) => String

Mustache.parse(
template : String,
tags = ['{{', '}}'] : Tags,
) => Token[]

interface Token [String, String, Number, Number, Token[]?, Number?]

interface Tags [String, String]

```
## Templates

A [mustache](http://mustache.github.com/) template is a string that contains any number of mustache tags. Tags are indicated by the double mustaches that surround them. `{{person}}` is a tag, as is `{{#person}}`. In both examples we refer to `person` as the tag's key. There are several types of tags available in mustache.js, described below.
Expand Down

0 comments on commit c41045b

Please sign in to comment.