42 lines
1.9 KiB
TypeScript
42 lines
1.9 KiB
TypeScript
import { APICacheOptions } from '../../download/api/types.js';
|
|
import { DocumentNotModified } from '../../download/types/modified.js';
|
|
import { FigmaDocument } from './types/api.js';
|
|
import { FigmaIfModifiedSinceOption, FigmaFilesQueryOptions, FigmaImagesQueryOptions } from './types/options.js';
|
|
import { FigmaNodesImportResult, FigmaIconNode } from './types/result.js';
|
|
import '../../icon-set/index.js';
|
|
import '@iconify/types';
|
|
import '@iconify/utils/lib/customisations/defaults';
|
|
import '../../icon-set/types.js';
|
|
import '../../svg/index.js';
|
|
import 'cheerio';
|
|
import '@iconify/utils/lib/icon-set/tree';
|
|
import './types/nodes.js';
|
|
|
|
/**
|
|
* Extra parameters added to runConcurrentQueries()
|
|
*
|
|
* Can be used to identify failed items in onfail callback
|
|
*/
|
|
interface FigmaIconNodeWithURL extends FigmaIconNode {
|
|
url: string;
|
|
}
|
|
type FigmaConcurrentQueriesParamsFunction = 'figmaImagesQuery' | 'figmaDownloadImages';
|
|
interface FigmaConcurrentQueriesParams<T extends FigmaConcurrentQueriesParamsFunction> {
|
|
function: T;
|
|
payload: T extends 'figmaImagesQuery' ? string[][] : FigmaIconNodeWithURL[];
|
|
}
|
|
/**
|
|
* Get Figma files
|
|
*/
|
|
declare function figmaFilesQuery<T extends FigmaIfModifiedSinceOption & FigmaFilesQueryOptions>(options: T, cache?: APICacheOptions): Promise<FigmaDocument | DocumentNotModified>;
|
|
declare function figmaFilesQuery(options: FigmaFilesQueryOptions, cache?: APICacheOptions): Promise<FigmaDocument>;
|
|
/**
|
|
* Generate all images
|
|
*/
|
|
declare function figmaImagesQuery(options: FigmaImagesQueryOptions, nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
|
|
/**
|
|
* Download all images
|
|
*/
|
|
declare function figmaDownloadImages(nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
|
|
|
|
export { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };
|