open-index/open-npm huggingface dataset:
npm package: @neosjs/create-image
Description: 根据`Dom`创建图片。支持生成`png`、`jpeg`、`blob`、`canvas`。
Author: 听着情歌流泪
Latest version: 1.0.1

# @neosjs/create-image

根据`Dom`创建图片。支持生成`png`、`jpeg`、`blob`、`canvas`。

## 安装

```bash
# npm
npm install @neosjs/create-image
# yarn
yarn add @neosjs/create-image
# pnpm
pnpm add @neosjs/create-image
```

## 使用

### 直接使用

```ts
import createImage from '@neosjs/create-image'
const res = await createImage.png(dom,options)
console.log(res)
```

### 别名方式

```ts
import { createPng } from '@neosjs/create-image'

const create = () => {
  const dom = document.getElementById('dom')
  createPng(dom).then(res => {
    console.log(res)
  })
}
```

## 示例

```ts
import createImage from '@neosjs/create-image'

const create = () => {
  const dom = document.getElementById('dom')
  createImage.png(dom).then(res => {
    console.log(res)
  })
}
```

## 方法

| 方法 | 别名 | 说明 |
| :--- | :--- | :--- |
| png | createPng | 生成png图片 |
| jpeg | createJpeg | 生成jpeg图片 |
| blob | createBlob | 生成blob |
| canvas | createCanvas | 生成canvas |

## 别名方法

| 方法 | 说明 |
| :--- | :--- |
| createPng | 生成png图片 |
| createJpeg | 生成jpeg图片 |
| createBlob | 生成blob |
| createCanvas | 生成canvas |

## 参数

| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| :--- | :--- | :---: | :---: | :---: |
| filter | 过滤不需要被截进图里的dom | Function | - | - |
| bgColor | 背景色 | String | - | - |
| width | 生成图片的宽度 | Number | - | - |
| height | 生成图片的高度 | Number | - | - |
| style | 样式 | Object | - | - |
| quality | 图片质量 | Number | 0-1 | 1 |
| scale | 缩放比例 | Number | - | 1 |
| placeholder | 图片占位符 | String | - | - |
| corsImg | 跨域图片 | Object | - | - |
| httpTimeout | 请求跨域图片的超时时间 | Number | - | 30000 |