sketch-file

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

★ 48 Open GitHub ↗

Methods to make is easier to manipulate a Sketch file

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sketch-file

A Sketch file is a zip file containing a bunch of JSON files.

This package aims to make is easier to manipulate such a file.

## Installation

```bash
npm install sketch-file
```

## Usage

There are 4 different methods available:

- [`readSketchFile`](#readsketchfile)
- [`createNewSketchFile`](#createnewsketchfile)
- [`writeSketchFile`](#writesketchfile)
- [`generateId`](#generateid)

### `readSketchFile`

```js
(filePath: string) => Promise<{
    document: FileFormat.Document;
    meta: FileFormat.Meta;
    user: FileFormat.User;
    pages: FileFormat.Page[];
    images: {
        [id: string]: Buffer;
    };
}>
```

### `createNewSketchFile`

```js
(version?: string) => {
    document: FileFormat.Document;
    meta: FileFormat.Meta;
    user: FileFormat.User;
    pages: FileFormat.Page[];
    images: {
        [id: string]: Buffer;
    };
}
```

### `writeSketchFile`

```js
({ document, meta, user, pages, images, }: {
    document: FileFormat.Document;
    meta: FileFormat.Meta;
    user: FileFormat.User;
    pages: FileFormat.Page[];
    images: {
        [id: string]: Buffer;
    };
}, filePath: string) => Promise<void>
```

### `generateId`

```js
;(seed?: string) => string
```

sketch-file

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README