Options
All
  • Public
  • Public/Protected
  • All
Menu

Module documentBuilder

Namespace documentBuilder

Index

Modules

Classes

Interfaces

Functions

Functions

getAvailableLocales

  • getAvailableLocales(): __type

  • Returns __type

getDocument

  • getDocument(identifier: number): IDocument | null

  • Parameters

    • identifier: number

    Returns IDocument | null

getDocuments

  • getDocuments(sortByPriority?: boolean): __type

  • Parameters

    • Optional sortByPriority: boolean

      (default: false)

    Returns __type

getElement

  • Parameters

    • identifier: number

    Returns IDocumentElement | null

getIdentifier

  • getIdentifier(): number

  • Returns number

getPrimaryLocale

  • getPrimaryLocale(): string | null

  • Returns string | null

getSystemTagByName

  • getSystemTagByName(tagName: string): ITag | null

  • Parameters

    • tagName: string

    Returns ITag | null

getTags

  • getTags(): __type

  • Returns __type

getTagsByName

  • getTagsByName(tagName: string): __type

  • Parameters

    • tagName: string

    Returns __type

getUserTagByName

  • getUserTagByName(tagName: string): ITag | null

  • Parameters

    • tagName: string

    Returns ITag | null

isValid

  • isValid(): boolean

  • Returns boolean

Generated using TypeDoc