Mercurial > irccd
comparison doc/src/api/module/Irccd.Directory/Irccd.Directory.find.md @ 607:bb9771fb5f44
Docs: rework documentation
- Change directories,
- Remove handwritten manual pages.
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Fri, 08 Dec 2017 20:11:22 +0100 |
| parents | doc/html/api/module/Irccd.Directory/Irccd.Directory.find.md@48676ca7071c |
| children | ebdc614db066 |
comparison
equal
deleted
inserted
replaced
| 606:4f5f306d13ac | 607:bb9771fb5f44 |
|---|---|
| 1 --- | |
| 2 function: find | |
| 3 js: true | |
| 4 summary: "Find an entry by a pattern or a regular expression." | |
| 5 synopsis: "Irccd.Directory.find(path, pattern, recursive)" | |
| 6 arguments: | |
| 7 - "**path**: the base path," | |
| 8 - "**pattern**: the regular expression or file name," | |
| 9 - "**recursive**: set to true to search recursively (Optional, default: false)." | |
| 10 returns: "The path to the file or undefined if not found." | |
| 11 throws: | |
| 12 - "Any exception on error." | |
| 13 --- |