Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Article

Hierarchy

Index

Constructors

constructor

  • Returns Article

Properties

asyncResults

asyncResults: TAsyncResult[]

fileData

fileData: string
prop()

isRendering

isRendering: boolean

markdownTs

markdownTs: typeof markdown

query

query: TQuery
prop()

redirectTo

redirectTo: (path: string, anchor?: string, query?: string) => boolean

Type declaration

    • (path: string, anchor?: string, query?: string): boolean
    • prop()

      Parameters

      • path: string
      • Optional anchor: string
      • Optional query: string

      Returns boolean

renderData

renderData: string

resultsBeforeRendered

resultsBeforeRendered: TAsyncResult[]

showTime

showTime: number
prop()

startTime

startTime: number

title

title: string
prop()

Accessors

anchor

  • get anchor(): string

filePath

  • get filePath(): string

html

  • get html(): string

isSearchFile

  • get isSearchFile(): boolean

queryContent

  • get queryContent(): string

Methods

renderComplete

  • renderComplete(): void

renderMD

  • renderMD(data?: string): void

scrollToAnchor

  • scrollToAnchor(): void

updateRenderData

  • updateRenderData(data?: string): Promise<void>

Generated using TypeDoc