https://github.com/soixantecircuits/media-helper
A small node module to help detecting and converting files through URL/file sytem Edit
https://github.com/soixantecircuits/media-helper
Last synced: 3 months ago
JSON representation
A small node module to help detecting and converting files through URL/file sytem Edit
- Host: GitHub
- URL: https://github.com/soixantecircuits/media-helper
- Owner: soixantecircuits
- License: mit
- Created: 2017-01-09T13:40:07.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T01:40:19.000Z (over 2 years ago)
- Last Synced: 2024-04-25T09:41:04.464Z (about 1 year ago)
- Language: JavaScript
- Size: 5.15 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# media-helper
## Installation
🤌 `pnpm add media-helper`
📦 `npm install media-helper --save`
⚡️ `yarn add media-helper`
## Usage
```js
const mh = require('media-helper')
const path = '/path/to/image.jpg'
const url = 'http://somesite.com/img.jpg'
if (mh.isFile(path)) {
console.log(path, ' is an existing file !')
mh.toBase64(path)
.then((data) => {
// data is the base64 datas for the file
})
.catch((err) => {
console.log(err)
})
}
if (mh.isURL(url)) {
console.log(url, ' is an URL !')
mh.toBase64(url)
.then((data) => {
// data is the base64 datas for the image
})
.catch((err) => {
console.log(err)
})
}
```
## API
| method | parameters | returns | description |
| :------------- | :--------: | :-------------: | :---------------------------------------------------------------------------------------- |
| `isBase64` | `string` | `boolean` | Determines if a string is base64 encoded. |
| `isFile` | `path` | `boolean` | Determines if a string describes a path to an existing file on your system. |
| `isURL` | `url` | `boolean` | Determines if a string describes an HTTP URL. |
| `isBuffer` | `Buffer` | `boolean` | Determines if an object is a `Buffer`. |
| `getMimeType` | `path` | `Promise` | Determines the mime-type of a file on your system. |
| `isImage` | `path` | `Promise` | Determines if a file is an image. |
| `isVideo` | `path` | `Promise` | Determines if a file is a video. |
| `toBuffer` | `string` | `Promise` | Converts an image to Buffer. `string` can describe either a path, base64 datas or an url. |
| `toBase64` | `string` | `Promise` | Converts an image to base64. `string` can describe either a path or an url. |
| `urlToBase64` | `url` | `Promise` | Converts an image to base64 through an URL. |
| `fileToBase64` | `path` | `Promise` | Converts an image on your system to base64. |
| `trimDataURI` | `dataURL` | `base64 string` | Returns a base64 string without the dataURI scheme ("data;mime/type;base64,") |