Module lua.nd.box
The Box of notes.
Object is used to interact with, find and gather notes.
Functions
| Box:gather_async () | Gather all notes in the background. |
| Box:by_filename (filename) | Find a note by filename. |
| Box:by_title (title) | Find a note by title. |
| Box:setup (opts) | Instantiate the box. |
Functions
- Box:gather_async ()
- Gather all notes in the background. Fills the box with notes from the given directory.
- Box:by_filename (filename)
-
Find a note by filename.
Partially matches, returns first result.
Parameters:
- filename string: The filename to search for
Returns:
-
Note: Note object found
- Box:by_title (title)
-
Find a note by title.
Partially matches, returns first result.
Parameters:
- title string: The title to search for
Returns:
-
Note: The first note object that's found
- Box:setup (opts)
-
Instantiate the box.
Also starts gathering notes asynchronously in the background
Parameters:
- opts table: A table of options
Returns:
-
Box: The instantiated box