Skip to content

Commit

Permalink
docs(includer): edit function parameters names (originalPath, parsedP…
Browse files Browse the repository at this point in the history
…ath) to be more descriptive
  • Loading branch information
leomp12 committed May 16, 2020
1 parent 8da7213 commit 247c0e2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,11 @@ Therefore, we do not recommend using this shortcut.
output inside scriptlet tags.
- `async` When `true`, EJS will use an async function for rendering. (Depends
on async/await support in the JS runtime.
- `includer` Custom function to handle EJS includes, receives `(url, prev)` parameters,
where `url` is the path in include as-is and `prev` is the previously resolved path. Should
return an object `{ filename, template }`, you may return only one of the properties,
where `filename` is the final parsed path and `template` is the included content.
- `includer` Custom function to handle EJS includes, receives `(originalPath, parsedPath)`
parameters, where `originalPath` is the path in include as-is and `parsedPath` is the
previously resolved path. Should return an object `{ filename, template }`,
you may return only one of the properties, where `filename` is the final parsed path and `template`
is the included content.

This project uses [JSDoc](http://usejsdoc.org/). For the full public API
documentation, clone the repository and run `npm run doc`. This will run JSDoc
Expand Down

0 comments on commit 247c0e2

Please sign in to comment.