Skip to content

Commit bb2ff83

Browse files
epwalshgithub-actions[bot]
authored andcommitted
chore(docs): auto generate docs
1 parent 51ca4dd commit bb2ff83

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/obsidian_api.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,26 @@ Parameters ~
250250
{opts} `(obsidian.SearchOpts|table|boolean|?)` search options or a boolean indicating if sorting should be used
251251
{callback} `(function(string[]))` -> nil
252252

253+
------------------------------------------------------------------------------
254+
*obsidian.Client.apply_async()*
255+
`Client.apply_async`({self}, {on_note}, {on_done}, {timeout})
256+
Apply a function over all notes in the current vault.
257+
258+
Parameters ~
259+
{on_note} `(function)` (obsidian.Note,) -> nil
260+
{on_done} `(function)` () -> nil
261+
{timeout} `(integer|?)` Timeout in milliseconds.
262+
263+
------------------------------------------------------------------------------
264+
*obsidian.Client.apply_async_raw()*
265+
`Client.apply_async_raw`({self}, {on_path}, {on_done}, {timeout})
266+
Like apply, but the callback takes a path instead of a note instance.
267+
268+
Parameters ~
269+
{on_path} `(function)` (string,) -> nil
270+
{on_done} `(function)` () -> nil
271+
{timeout} `(integer|?)` Timeout in milliseconds.
272+
253273
------------------------------------------------------------------------------
254274
*obsidian.Client.new_note_id()*
255275
`Client.new_note_id`({self}, {title})

0 commit comments

Comments
 (0)