Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Note

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

    • title: string
    • Default value time: number = new Date().getTime()
    • Default value elements: NoteElement[] = []
    • Default value bibliography: Source[] = []
    • Optional internalRef: undefined | string
    • Optional parent: Parent | string

    Returns Note

Properties

Readonly bibliography

bibliography: Source[]

Readonly elements

elements: NoteElement[]

Readonly internalRef

internalRef: string

parent

parent: Parent | string | undefined

Readonly time

time: number

Readonly title

title: string

Methods

addElement

addSource

  • Parameters

    Returns 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

  • Parameters

    • Default value opts: Partial<Note> = {}

    Returns Note

Protected generateGuid

  • generateGuid(): string

getHashtags

  • getHashtags(): string[]

  • Returns string[]

search

  • search(query: string): Note[]

toMarkdown

  • Parameters

    Returns Promise<MarkdownNote>

toXmlObject

  • toXmlObject(): any

Generated using TypeDoc