sketch-constructor/models/Sketch/index.d.ts

Read/write/manipulate Sketch files in Node without Sketch plugins!

import fs  from 'fs';
import JSZip from 'jszip';
import Meta from '../Meta';
import User from '../User';
import Document from '../Document';
import Page from '../Page';
import SharedStyle from '../SharedStyle';
import Swatch from '../Swatch';

declare class Sketch {
  static fromFile(path: fs.PathLike): Promise<Sketch>;

  static fromExtractedFile(path: fs.PathLike): Promise<Sketch>;

  static addPreview(preview: fs.PathLike): void;

  document: Document;
  meta: Meta;
  user: User;
  pages: Page[];
  zip: JSZip;

  constructor(args?: any);

  getPages(predicate?: string | RegExp): Page[];

  getPage(name: string): Page | undefined;

  getLayerStyles(): SharedStyle[];

  getLayerStyle(name: string): SharedStyle | undefined;

  addLayerStyle(style: SharedStyle): void;

  addTextStyle(style: SharedStyle): void;

  getTextStyles(): SharedStyle[];

  addSwatch(swatch: Swatch): void;

  getSwatches(): Swatch[];

  addPage(page: any, args?: any): void;

  addArtboard(pageID: string, artboard: any): void;

  build(output: fs.PathLike | number, compressionLevel: number): Promise<fs.PathLike | number>;
}

export = Sketch;