# node-three-screenshot

> Take a PNG screenshot of a THREE scene

Latest version **1.0.1** (published 2018-05-15) · 0 weekly downloads

## Install

```sh
npm install node-three-screenshot
pnpm add node-three-screenshot
yarn add node-three-screenshot
bun add node-three-screenshot
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-05-15 |
| First published | 2018-05-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19 |
| Maintainers | dbkaplun |

## Links

- npm: https://www.npmjs.com/package/node-three-screenshot
- Repository: https://github.com/dbkaplun/node-three-screenshot
- Issues: https://github.com/dbkaplun/node-three-screenshot/issues
- npm.io page: https://npm.io/package/node-three-screenshot

## Dependencies (2)

- [three](https://npm.io/package/three.md) ^0.92.0
- [canvas](https://npm.io/package/canvas.md) ^1.6.10

## Recent versions

- 1.0.1 (latest) — 2018-05-15
- 1.0.0 — 2018-05-15

## README

# node-three-screenshot [![Build Status](https://travis-ci.com/dbkaplun/node-three-screenshot.svg?branch=master)](https://travis-ci.com/dbkaplun/node-three-screenshot)
Take a PNG screenshot of a THREE scene

## Usage

*[You will need to install the dependencies for node-canvas.](https://github.com/Automattic/node-canvas#compiling)*

```sh
$ npm install node-three-screenshot
```

```js
import { toPNG } from 'node-three-screenshot';

fs.writeFileSync('out.png', toPNG(scene));
```

### With Jest

```sh
$ npm install jest-image-snapshot
```

```js
import { toPNG } from 'node-three-screenshot';
import { toMatchImageSnapshot } from 'jest-image-snapshot';

expect.extend({ toMatchImageSnapshot });

expect(toPNG(obj)).toMatchImageSnapshot();
```

---
_Source: https://npm.io/package/node-three-screenshot · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._