https://github.com/murongg/image2file
Simple image / svg / psd / file convert.
https://github.com/murongg/image2file
convert file gif jpeg jpg png psd svg
Last synced: 5 months ago
JSON representation
Simple image / svg / psd / file convert.
- Host: GitHub
- URL: https://github.com/murongg/image2file
- Owner: murongg
- License: mit
- Created: 2022-06-29T08:04:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-02T03:02:48.000Z (over 3 years ago)
- Last Synced: 2025-01-21T12:25:28.251Z (9 months ago)
- Topics: convert, file, gif, jpeg, jpg, png, psd, svg
- Language: TypeScript
- Homepage:
- Size: 135 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# image2file
[](https://www.npmjs.com/package/image2file)
## 📎 Installation
```sh
$ npm install image2file
```
## 👽 Usage
```js
import { imageToBase64 } from 'image2file'
```
## ✈️ Functions
### Image Functions
| name | description |
| ------------------------- | ------------------------------ |
| `imageDataToFile` | ImageData to File |
| `imageElementToFile` | HTMLImageElement to File |
| `imageDataToImageElement` | ImageData to HTMLImageElement |
| `imageToBase64` | Image to Base64 |
| `imageToImageElement` | Image file to HTMLImageElement |
| `imageFileToBase64` | Image file to Base64 |
| `imageToSvg` | Image to SVG |
| `imageFileToSvg` | Image file to SVG |
### SVG Functions
| name | description |
| ------------------- | ---------------------- |
| `svgToBase64` | SVG to svg base64 |
| `svgFileToBase64` | SVG File to SVG Base64 |
| `svgToImageElement` | SVG to ImageElement |
| `svgToImageBase64` | SVG to image base64 |
| `svgToImageFile` | SVG to image file |
### PSD Functions
| name | description |
| ------------------- | ----------------------- |
| `psdToImageFile` | PSD to image file |
| `psdToImageElement` | PSD to HTMLImageElement |
| `psdToImageData` | PSD to ImageData |
| `psdToBase64` | PSD to Base64 |
| `psdToSvg` | PSD to SVG |
### Other Functions
| name | description |
| ---------------------- | -------------------------- |
| `fileToBase64` | File to Base64 |
| `blobToArrayBuffer` | Blob to ArrayBuffer |
| `base64ToFile` | Base64 to File |
| `base64ToImageElement` | Base64 to HTMLImageElement |
## Type Declares
```ts
function generateFileReader(source: File | Blob): Promise
function fileToBase64(source: File): Promise
function blobToArrayBuffer(source: Blob): Promise
function base64ToFile(base64: string, filename: string): File
function base64ToImageElement(base64: string): HTMLImageElement
function imageDataToFile(imageData: ImageData, filename: string, fileType?: string, quality?: number): Promise
function imageElementToFile(imageEl: HTMLImageElement, filename: string, fileType?: string, quality?: number): Promise
function imageDataToImageElement(imageData: ImageData, fileType?: string, quality?: number): Promise
function imageToImageElement(imageFile: File): Promise
function imageToBase64(image: ImageData | HTMLImageElement, fileType?: string, quality?: number): Promise
function imageFileToBase64(imageFile: File): Promise
function imageToSvg(image: string): Promise
function imageFileToSvg(imageFile: File): Promise
function psdToImageFile(file: File, fileType?: string, quality?: number): Promise
function psdToImageElement(file: File, fileType?: string, quality?: number): Promise
function psdToImageData(file: File): Promise
function psdToBase64(file: File, fileType?: string, quality?: number): Promise
function psdToSvg(file: File, fileType?: string, quality?: number): Promise
function svgToBase64(file: File | SVGElement): Promise | undefined
function svgFileToBase64(file: File): Promise | undefined
function svgElementToBase64(file: SVGElement): Promise | undefined
function svgToImageElement(file: File): Promise
function svgToImageBase64(file: File, fileType?: string, quality?: number): Promise
function svgToImageFile(file: File, fileType?: string, quality?: number): Promise
```