standard-replicator
    Preparing search index...

    Class BaseProgram

    Yet to be documented.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    agent: Agent
    atprotoAccountHandle: string = ""

    The AT Protocol account handle.

    atprotoAccountPassword: string = ""

    The AT Protocol account password.

    contentPath: string = ""

    The directory path to the collection of markdown documents.

    indexNow: IndexNow
    indexNowKey: string = ""

    The IndexNow key for requesting search engines to crawl pages.

    initialized: boolean
    maxDescriptionLength: number = 350

    The maximum length in character of the description.

    resolvedPath: string
    siteHostName: string = ""

    The site hostname to associate the documents with.

    standardSitePublicationUri: string = ""

    The URI of the publication to associate documents with.

    statusPersistence: StatusPersister
    indexNowClass: typeof IndexNow = IndexNow
    parserClass: typeof Parser = Parser
    statusPersisterClass: typeof StatusPersister = StatusPersister

    Methods

    • Parameters

      • document: Document

      Returns Promise<any>

      Yet to be documented.

    • Determines if the provided frontmatter is to publish the document.

      Parameters

      • frontmatter: any

      Returns boolean

    • Parameters

      • relativeFilePath: string

        The file path relative to the content directory. i.e.: People/Son of jackson.md.

      Returns string

      Yet to be documented.

    • Parameters

      • relativeFilePath: string

        The file path relative to the content directory. i.e.: People/Son of jackson.md.

      Returns string

      Yet to be documented.

    • Explores recursively a directory and returns all the file paths and folder paths.

      Parameters

      • dir: string

        The directory to explore

      • Optionallimit: number = Infinity

        The maximum depth to explore

      Returns Promise<string[]>

      • A promise that resolves to an array of file paths and folder paths