Skip to content

Commit bedc1b3

Browse files
committed
feat: added getFileImages
1 parent 89c4961 commit bedc1b3

File tree

3 files changed

+25
-3
lines changed

3 files changed

+25
-3
lines changed

src/figma-api.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { request } from './utils';
2-
import { getFileOptionalParams, getFileNodesOptionalParams, getTeamStylesOptionalParams } from './types';
2+
import { getFileOptionalParams, getFileNodesOptionalParams, getFileImagessOptionalParams, getTeamStylesOptionalParams } from './types';
33

44
export const getFile = (fileId: string, optionalParams?: getFileOptionalParams) => {
55
const url = new URL(`https://api.figma.com/v1/files/${ fileId }`);
@@ -24,6 +24,17 @@ export const getFileNodes = (fileId: string, nodeIds: string, optionalParams?: g
2424
return request(url);
2525
}
2626

27+
export const getFileImages = (fileId: string, nodeIds: string, optionalParams?: getFileImagessOptionalParams) => {
28+
const url = new URL(`https://api.figma.com/v1/images/${ fileId }`);
29+
url.searchParams.set('ids', nodeIds);
30+
31+
for (const param in optionalParams) {
32+
url.searchParams.set(param, optionalParams[param]);
33+
}
34+
35+
return request(url);
36+
}
37+
2738
export const getFileStyles = (fileId: string) => {
2839
const url = new URL(`https://api.figma.com/v1/files/${ fileId }/styles`);
2940

src/index.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
import {
2-
getFile,
3-
getFileNodes,
2+
getFile,
3+
getFileNodes,
4+
getFileImages,
45
getFileStyles,
56
getTeamStyles
67
} from './figma-api';
78

89
export { getFile as getFile };
910
export { getFileNodes as getFileNodes };
11+
export { getFileImages as getFileImages };
1012
export { getFileStyles as getFileStyles };
1113
export { getTeamStyles as getTeamStyles };

src/types.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ export interface getFileNodesOptionalParams {
1313
plugin_data?: string
1414
}
1515

16+
export interface getFileImagessOptionalParams {
17+
scale?: number,
18+
format?: string,
19+
svg_include_id?: boolean,
20+
svg_simplify_stroke?: boolean,
21+
use_absolute_bounds?: boolean,
22+
version?: string
23+
}
24+
1625
export interface getTeamStylesOptionalParams {
1726
page_size?: number,
1827
after?: number,

0 commit comments

Comments
 (0)