Export file assets API Reference

CLI

Configuration for export command in .figma.config.js.

• Basic configuration

export interface ExportFileAssetsCliParams extends BasicConfiguration {
  /**
   * "file-assets" is using by default, so you don't need to specify it.
   */
  type?: 'file-assets';
  /**
   * Optional if you already defined `fileId` in root configuration.
   */
  fileId?: string;
  /**
   * Path to the output directory of exported files (relative to the current working directory)
   */
  output?: string;
}

Node.js

In Node.js, you can use exportFileAssets function to export assets from a Figma file.

declare function exportFileAssets(params: ExportFileAssetsParams): Promise<void>;

• ctx: ExportContext
• Basic configuration

export interface ExportFileAssetsParams extends BasicConfiguration {
  ctx: ExportContext;
}

Basic configuration

• write: WriteDownloadedAssetsConfig
• collect: CollectNodesParams (except log)
• resolve: ResolveExportedAssetsConfig
• download: DownloadExportedAssetsConfig

export interface BasicConfiguration {
  write?: WriteDownloadedAssetsConfig<AnyGraphNode, GraphNode<DocumentNode>>;
  collect?: CollectNodesParams;
  /**
   * File nodes have their own optional user-defined export settings.
   * To cover it, you could pass `resolve.exportAs: "export"`
   *
   * @example {
   *   resolve: {
   *     exportAs: "export",
   *   }
   * }
   */
  resolve?: ResolveExportedAssetsConfig<AnyGraphNode, typeof fileGraphResolversMap>;
  download?: DownloadExportedAssetsConfig;
}