From c41045baf8fcb14cc6b48db4b784dcef3e82cd26 Mon Sep 17 00:00:00 2001 From: Phillip Johnsen Date: Sat, 11 Jan 2020 21:07:08 +0100 Subject: [PATCH] Removing the rtype API definitions from README 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). --- README.md | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/README.md b/README.md index b16fd13..60bb97e 100644 --- a/README.md +++ b/README.md @@ -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.