Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Note

Hierarchy

  • NPXObject
    • Note

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Note(title: string, time?: number, elements?: NoteElement[], bibliography?: Source[], internalRef?: string, parent?: string | Parent): Note

  • Parameters

    • title: string
    • time: number = ...
    • elements: NoteElement[] = []
    • bibliography: Source[] = []
    • Optional internalRef: string
    • Optional parent: string | Parent

    Returns Note

Properties

Readonly bibliography

bibliography: Source[] = []

Readonly elements

elements: NoteElement[] = []

Readonly internalRef

internalRef: string

parent

parent: undefined | string | Parent

Readonly time

time: number = ...

Readonly title

title: string

Methods

addElement

  • addElement(element: NoteElement): Note

addSource

  • addSource(source: Source): Note

Protected clean

  • clean(str: string): string

  • Parameters

    • str: string

    Returns string

    The string without certain values that could cause parsing issues in the future

clone

Protected generateGuid

  • generateGuid(): string

  • Returns string

getHashtags

  • getHashtags(): string[]

getHeadingWords

  • getHeadingWords(): Set<string>

search

  • search(query: string): Note[]

  • Parameters

    • query: string

    Returns Note[]

toMarkdown

  • toMarkdown(assets: Asset[]): Promise<MarkdownNote>

  • Parameters

    Returns Promise<MarkdownNote>

toXmlObject

  • toXmlObject(): any

  • Returns any

Generated using TypeDoc