Add method Note:get_field(key: string)

Author: epwalsh

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added client method `Client:current_note()` to get the note corresponding to the current buffer.
 - Added note method `Note.add_field(key: string, value: any)` to add/update an additional field in the frontmatter.
+- Added note method `Note.get_field(key: string)`.
 - Added note method ` Note.save_to_buffer(bufnr: integer|?, frontmatter: table|?)` for saving the frontmatter to a buffer.
 
 ## [v2.8.0](https://github.com/epwalsh/obsidian.nvim/releases/tag/v2.8.0) - 2024-01-26

lua/obsidian/note.lua

@@ -148,6 +148,23 @@ Note.add_field = function(self, key, value)
   self.metadata[key] = value
 end
 
+--- Get a field in the frontmatter.
+---
+---@param key string
+---
+---@return any result
+Note.get_field = function(self, key)
+  if key == "id" or key == "aliases" or key == "tags" then
+    error "Getting field '%s' this way is not allowed. Please use the corresponding attribute directly instead"
+  end
+
+  if not self.metadata then
+    return nil
+  end
+
+  return self.metadata[key]
+end
+
 --- Initialize a note from a file.
 ---
 ---@param path string|Path