Note Module
Overview
The Note Module provides a suite of methods which provide access to the current note (calendar or project note). If there is no current note, each method will return an empty value
Methods
namespace:
note
The following are the methods available in the Note Module, and they can be used in any np.Templating template, no additional configuration.
filename
filename() : string
Returns the current note filename as it appears on disk. This may be different than the note title. You an use the
note.titlemethod if you wish to access the actual note title.
Examples:
The following example will return the filename for the current calendar note.
Assuming the current note is May 29, 2022, the value returned will be 20220529.md
<%- note.filename() %> // returns 20220529.md
The following example will return the filename for the current project note
Assuming the current note has a title of "# Todo List" located in the "Projects", the value returned will be Projects/Todo List.md
<%- note.filename() %> // returns Projects/Todo List.md
title
title() : string
Returns the title of the current note, which may be either a calendar or project note.
- If the current note is a calendar note, the value will be a date string in YYYY-MM-DD format
- If the current note is a project note, the value will be the first line
-> title - Returns note title
Examples:
The following will return the note title.
Assuming the current note is May 29, 2022, the value returned will be 2022-05-29
<%- note.title() %> // returns 2022-05-29
The following example will return the filename for the current project note
Assuming the current note has a title of "# Todo List" the value returned will be Todo List
<%- note.title() %> // returns Todo List
content
content(stripFrontmatter: boolean = false) : string
Returns content of current note in markdown format
stripFrontmatter(default:false) - Iftrue, content frontmatter will be stripped.- ->
content- Returns content of current note
Example:
The following will return the content of current note
<%- note.content() %> // Markdown formatted content of current note
date
date(format: ?string = '') : date
Returns the date value of a calendar note. If the current note is a project note, an empty string will be returned
format- Optional date format
-> date - Returns date string of calendar note
Examples:
The following will return the note date (calendar note only).
Assuming the current note is May 29, 2022, the value returned will be Sun May 29 2022 00:00:00 GMT-0700 (PDT)
<%- note.date() %> // Sun May 29 2022 00:00:00 GMT-0700 (PDT)*
The following will return the note date (calendar note only).
Assuming the current note is May 29, 2022, the value returned will be 2022-05-29
<%- note.date('YYYY-MM-DD') %> // returns 2022-05-29
createdDate
createdDate(format: ?string = '') : date
Returns the created date value of the current note
format- Optional date format
-> date - Returns created date string of current note
Examples:
The following will return the note created date.
<%- note.createdDate() %> // Sun May 29 2022 00:00:00 GMT-0700 (PDT)*
The following will return the created date using supplied format.
<%- note.createdDate('YYYY-MM-DD') %> // returns 2022-05-29
changedDate
changedDate(format: ?string = '') : date
Returns the changed date value of the current note
format- Optional date format
-> date - Returns changed date string of current note
Examples:
The following will return the note changed date.
<%- note.changedDate() %> // Sun May 29 2022 00:00:00 GMT-0700 (PDT)*
The following will return the changed date using supplied format.
<%- note.changedDate('YYYY-MM-DD') %> // returns 2022-05-29
hashtags
hashtags() : string
Returns comma separated list of hashtags located in current note
-> hashtags - Returns list of all hashtags in current note
Example:
The following will comma separated list of hashtags
<%- note.hashtags() %> // #tag1, #tag2, ...
mentions
mentions() : string
Returns comma separated list of mentions located in current note
-> mentions - Returns list of all mentions in current note
Example:
The following will return comma separated list of mentions
<%- note.mentions() %> // #tag1, #tag2, ...
paragraphs
paragraphs() : string
Returns an array of paragraph objects for the current note
-> paragraphs - Returns an array of paragraph objects for the current note
Each object in paragraph array will contain the following keys
type - type of paragraph
content - content
rawContent - content including any markdown
prefix - The first character of the rawContent
heading - Paragraph heading
isRecurring - If this paragraph is a todo item, is it recurring
filename - Same as filename command above
noteType - Type of note which paragraphs are associated.
Calendar if note is a calendar note Notes if the note is a regular project note
linkedNoteTitles- An array of titles for any linked notessubItems- An array of subitemsreferenceBlocks- An array of all reference items (those references listed at the top of note)
Example:
The following will iterate through all paragraph objects for the current note.
<% const paragraphs = await note.paragraphs() -%>
<% paragraphs.map(item => { -%>
<%- item.key + ' : ' + item.value %>
<%}) -%>
type : title
content : Tue, May 31, 2022
rawContent : # Tue, May 31, 2022
prefix : #
heading :
isRecurring : false
filename : 20220531.md
noteType : Calendar
linkedNoteTitles :
subItems :
referencedBlocks :
type : text
content : *Created: 2022-05-31 2:21 pm*
rawContent : *Created: 2022-05-31 2:21 pm*
prefix :
heading : Tue, May 31, 2022
isRecurring : false
filename : 20220531.md
noteType : Calendar
linkedNoteTitles :
subItems :
referencedBlocks :
*****
### datedTodos
> #### datedTodos() : array
Returns array paragraphs contained in this note which contain a link to a daily note.
-> `datedTodos` - Returns an array of datedTodos objects for the current note
*****
### backlinks
> #### backlinks() : array
Returns array of all backlinks pointing to the current note as Paragraph objects.
In this array, the top level items are all notes linking to the current note and the 'subItems' attributes (of the paragraph objects) contain the paragraphs with a link to the current note.
The headings of the linked paragraphs are also listed here, although they don't have to contain a link.
-> `datedTodos` - Returns an array of datedTodos objects for the current note