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

accessToken? baseUrl expand? limit maxRetries personalAccessToken? spaceKey username?

Methods

fetchConfluenceData load loadAndSplit

Constructors

constructor

Properties

Optional ReadonlyaccessToken

accessToken?: string

ReadonlybaseUrl

baseUrl: string

Optional Readonlyexpand

expand?: string

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

Readonlylimit

limit: number

ReadonlymaxRetries

maxRetries: number

Optional ReadonlypersonalAccessToken

personalAccessToken?: string

ReadonlyspaceKey

spaceKey: string

Optional Readonlyusername

username?: string

Methods

ProtectedfetchConfluenceData

load

  • load(options?): Promise<Document<Record<string, any>>[]>

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

    Parameters

    • Optionaloptions: {
          limit?: number;
          start?: number;
      }

      the extra options of the load function

      • Optionallimit?: number

        The limit parameter to overwrite the size to fetch pages.

      • Optionalstart?: number

        The start parameter to set inital offset to fetch pages.

    Returns Promise<Document<Record<string, any>>[]>

    Promise resolving to an array of Document instances.

loadAndSplit

  • loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>

  • Parameters

    • Optionalsplitter: BaseDocumentTransformer<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[]>

    Returns Promise<Document<Record<string, any>>[]>

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

    Deprecated

    Use this.load() and splitter.splitDocuments() individually. Loads the documents and splits them using a specified text splitter.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods