| title | readNote |
|---|---|
| sidebar_label | readNote |
Read the contents of a note
| param | type [= default] | description |
|---|---|---|
| core | string = 'default' | The plugin core identifier to use for plugin injection |
| fs [deprecated] | FileSystem | The filesystem containing the git repo. Overrides the fs provided by the plugin system. |
| dir | string | The working tree directory path |
| gitdir | string = join(dir,'.git') | The git directory path |
| ref | string | The notes ref to look under |
| oid | string | The SHA-1 object id of the object to get the note for. |
| return | Promise<Buffer> | Resolves successfully with note contents as a Buffer. |