Class FigmaFileLoader

Class representing a document loader for loading Figma files. It extends the BaseDocumentLoader and implements the FigmaLoaderParams interface. The constructor takes a config object as a parameter, which contains the access token, an array of node IDs, and the file key.

Example

const loader = new FigmaFileLoader({
  accessToken: "FIGMA_ACCESS_TOKEN",
  nodeIds: ["id1", "id2", "id3"],
  fileKey: "key",
});
const docs = await loader.load();

Hierarchy (view full)

Implements

Constructors

constructor

Properties

accessToken? fileKey nodeIds

Methods

load loadAndSplit

Constructors

constructor

Properties

OptionalaccessToken

accessToken?: string

fileKey

fileKey: string

nodeIds

nodeIds: string[]

Methods

load

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

  • Fetches the Figma file using the Figma API, creates a Document instance with the JSON representation of the file as the page content and the API URL as the metadata, and returns it.

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

    A Promise that resolves 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