Mercurial > irccd

view doc/src/api/module/Irccd.Directory/Irccd.Directory.find.md @ 607:bb9771fb5f44

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
line wrap: on
line source

---
function: find
js: true
summary: "Find an entry by a pattern or a regular expression."
synopsis: "Irccd.Directory.find(path, pattern, recursive)"
arguments:
  - "**path**: the base path,"
  - "**pattern**: the regular expression or file name,"
  - "**recursive**: set to true to search recursively (Optional, default: false)."
returns: "The path to the file or undefined if not found."
throws:
  - "Any exception on error."
---