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

fileKey nodeIds accessToken?

Methods

load

Constructors

constructor

Properties

fileKey

fileKey: string

nodeIds

nodeIds: string[]

Optional accessToken

accessToken?: 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc