Interface: FileListOject

FileListOject

Resulting item representing content from repository
Source:

Members

content :string

Raw markup.
Type:
  • string
Source:

created :string|undefined

Creation date of item. Sourced from first commit.
Type:
  • string | undefined
Source:

frontmatter :FrontMatter

Frontmatter data in document.
Type:
  • FrontMatter
Source:

full_path :string

Full path string to item from root of repository.
Type:
  • string
Source:

path :PathObj

Split items from path string.
Type:
  • PathObj
Source:

reading_time :number

Amount of time to read. Rough calculation based on file byte size.
Type:
  • number
Source:

title :string|null

Title of document. Sourced from first heading element.
Type:
  • string | null
Source:

toc :Array

Table of contents of document.
Type:
  • Array
Source:

updated :string|undefined

Updated date of item. Sourced from last commit.
Type:
  • string | undefined
Source: