@figma-export/types - npm Package Compare versions

Comparing version 4.0.0-alpha.0 to 4.0.0-alpha.1

dist/commands.d.ts

@@ -1,4 +0,8 @@
-import { StringTransformer, ComponentOutputter } from './global';
-import { StyleOutputter } from './styles';
+import { StringTransformer, ComponentOutputter, PageNode } from './global';
+import { StyleOutputter, Style } from './styles';
 export declare type BaseCommandOptions = {
+    /**
+     * Personal access token.
+     * @see: https://www.figma.com/developers/api#access-tokens
+     */
     token: string;
@@ -8,12 +12,33 @@ log?: (msg: string) => void;
 export declare type ComponentsCommandOptions = {
+    /**
+     * File to export Components from.
+     * The file key can be parsed from any Figma file url: https://www.figma.com/file/:key/:title.
+     */
     fileId: string;
+    /**
+     * A specific version ID to get. Omitting this will get the current version of the file
+     * @see https://help.figma.com/hc/en-us/articles/360038006754-View-a-file-s-version-history
+     */
     version?: string;
+    /** Figma page names (all pages when not specified) */
     onlyFromPages?: string[];
+    /** Transformer module name or path */
     transformers?: StringTransformer[];
+    /** Outputter module name or path */
     outputters?: ComponentOutputter[];
+    /** Concurrency when fetching */
     concurrency?: number;
 };
 export declare type StylesCommandOptions = {
+    /**
+     * File to export Styles from.
+     * The file key can be parsed from any Figma file url: https://www.figma.com/file/:key/:title.
+     */
     fileId: string;
+    /**
+     * A specific version ID to get. Omitting this will get the current version of the file
+     * @see https://help.figma.com/hc/en-us/articles/360038006754-View-a-file-s-version-history
+     */
     version?: string;
+    /** Outputter module name or path */
     outputters?: StyleOutputter[];
@@ -24,2 +49,4 @@ };
 };
+export declare type ComponentsCommand = (options: BaseCommandOptions & ComponentsCommandOptions) => Promise<PageNode[]>;
+export declare type StylesCommand = (options: BaseCommandOptions & StylesCommandOptions) => Promise<Style[]>;
 //# sourceMappingURL=commands.d.ts.map

package.json

 {
     "name": "@figma-export/types",
-    "version": "4.0.0-alpha.0",
+    "version": "4.0.0-alpha.1",
     "description": "Type definition for @figma-export",
@@ -32,3 +32,3 @@ "main": "dist/index.js",
     },
-    "gitHead": "69e5443cdb4a4f8ad9bf482d0a7dcca1bb261d96"
+    "gitHead": "086711cbbf9ef49e4d49dc143b01902cb0909afc"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18790

increased by9.43%

Lines of code

243

increased by12.5%

No dependency changes