https://github.com/zyyv/untinyimg
A cli tools of tinypng.
https://github.com/zyyv/untinyimg
cli tinypng untiny util
Last synced: 6 months ago
JSON representation
A cli tools of tinypng.
- Host: GitHub
- URL: https://github.com/zyyv/untinyimg
- Owner: zyyv
- License: mit
- Created: 2023-02-10T12:48:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T06:26:37.000Z (over 1 year ago)
- Last Synced: 2025-05-05T07:13:57.131Z (6 months ago)
- Topics: cli, tinypng, untiny, util
- Language: TypeScript
- Homepage:
- Size: 1.79 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# untinyimg [](https://npmjs.com/package/untinyimg)
A cli tools of tinypng.
## Usage
```shell
npm i -D untinyimg
```
### Cli
You can use `untiny` command in your terminal
```shell
untiny -h # help
```
#### `untiny ci`
Compress a single image.
```shell
untiny ci ./test.png
```
#### `untiny cis`
Compress an array of images.
```shell
untiny cis ./test.png ./test2.png
```
#### `untiny cd`
Compress all images in the directory.
```shell
untiny cd ./test
```
#### untiny cli options
- `-c` or `--config` your config file path
- `-k` or `--key` your tinypng api key
- `-o` or `--out` your output file path
- `-d` or `--debug` print debug information
### Api
#### `createUntiny`
Create your untiny instance.
```ts
import { createUntiny } from 'untinyimg'
const untiny = createUntiny('your api key')
```
#### `compressDir`
Compress all images in the directory.
```ts
untiny.compressDir('your dir path of images')
```
#### `compressImages`
Compress all images with an array.
```ts
untiny.compressImages('your file path array of images')
```
#### `compressImage`
Compress a image.
```ts
untiny.compressImage('your file path of image')
```
### types
`compressDir`、`compressImages`、`compressImage` support options in second param.
```ts
export interface CompressOption {
/**
* convert file path to return a new file path
* @param originPath origin file path
* @param originImgName origin file name
* @returns new file path
*/
handler?: (originPath: string, originImgName: string) => string
/**
* Your desired image types. The following options are available as a type:
*/
convertType?: IMG_TYPE | IMG_TYPE[]
/**
* The transform object specifies the stylistic transformations that will be applied to your image
*/
transform?: string
/**
* Whether to print debug information
* @default true
*/
debug?: boolean
}
export type IMG_EXT = '.png' | '.jpg' | '.jpeg' | '.webp'
export type IMG_TYPE = 'image/png' | 'image/jpeg' | 'image/webp' | 'image/jpg' | '*/*'
```
## License
[MIT](./LICENSE) License © 2023 [zyyv](https://github.com/zyyv)