Class ConfluencePagesLoader

Class representing a document loader for loading pages from Confluence.

Example

const loader = new ConfluencePagesLoader({
  baseUrl: "https:
  spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
  username: "your-username",
  accessToken: "your-access-token",
});
const documents = await loader.load();
console.log(documents);

Hierarchy (view full)

Constructors

constructor

Properties

baseUrl limit spaceKey accessToken? expand? personalAccessToken? username?

Methods

load loadAndSplit fetchConfluenceData

Constructors

constructor

Properties

Readonly baseUrl

baseUrl: string

Readonly limit

limit: number

Readonly spaceKey

spaceKey: string

Optional Readonly accessToken

accessToken?: string

Optional Readonly expand

expand?: string

expand parameter for confluence rest api description can be found at https://developer.atlassian.com/server/confluence/expansions-in-the-rest-api/

Optional Readonly personalAccessToken

personalAccessToken?: string

Optional Readonly username

username?: string

Methods

load

  • load(options?): Promise<Document[]>

  • Fetches all the pages in the specified space and converts each page to a Document instance.

    Parameters

    • Optional options: {
          limit?: number;
          start?: number;
      }

      the extra options of the load function

      • Optional limit?: number

        The limit parameter to overwrite the size to fetch pages.

      • Optional start?: number

        The start parameter to set inital offset to fetch pages.

    Returns Promise<Document[]>

    Promise resolving to an array of Document instances.

loadAndSplit

  • loadAndSplit(splitter?): Promise<Document[]>

  • Loads the documents and splits them using a specified text splitter.

    Parameters

    • splitter: TextSplitter = ...

    Returns Promise<Document[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

Protected fetchConfluenceData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc