0.1.1 • Published 5 months ago
@signageos/file v0.1.1
File npm package
Determine type of FILEs.
A simple wrapper over file command available in Linux systems.
Package is supported for Windows (non-linux) as well.
Installation
npm i @signageos/file
Usage
import file from '@signageos/file';
(async function () {
const result = await file('/tmp/file-to-determine');
console.log(result); // { type: ['ASCII text'] }
})();
Interface
function file(filePath: string, options?: Options): Promise<Result>;
interface Options {
fileBinPath?: string; // path to file binary to be used instead of default
mimeType?: boolean; // if set to true, result will contain detected mime-type of file. Default false.
separator?: string; // default ':'
alternativeSeparators?: string[]; // default ['*', '$', '€']
}
interface Result {
mimeType?: string; // detected mime-type of file (if option mimeType set to true)
charset?: string; // detect charset of file (if option mimeType set to true)
types?: string[]; // get all detected general types (if no mimeType set)
}
Get version of file
import { getVersion } from '@signageos/file';
(async function () {
const version = await getVersion();
console.log(version); // file-5.32
})();
Limitations
Currently only following features are supported:
- type: Returns default type of given file (without arguments)
- mimeType: Returns detected mime-type of given file.
References
License
- MIT
0.1.2-dependabot-npm-and-yarn-ts-node-10-9-2.40
5 months ago
0.1.2-jk-fix-node-18.27
6 months ago
0.1.2-main.24
2 years ago
0.1.1-main.21
3 years ago
0.1.1-main.17
3 years ago
0.1.1-mz-win32-fix.18
3 years ago
0.1.1
3 years ago
0.1.1-mz-win32-fix.19
3 years ago
0.1.1-mz-win32-fix.20
3 years ago
0.1.1-mz-newer-win32-file.16
4 years ago
0.1.0
4 years ago
0.1.0-main.13
4 years ago
0.1.0-main.12
4 years ago
0.1.0-main.11
4 years ago
0.1.0-main.9
4 years ago
0.1.0-main.8
4 years ago