Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/filenamify
Convert a string to a valid safe filename
https://github.com/sindresorhus/filenamify
Last synced: 7 days ago
JSON representation
Convert a string to a valid safe filename
- Host: GitHub
- URL: https://github.com/sindresorhus/filenamify
- Owner: sindresorhus
- License: mit
- Created: 2015-01-14T05:23:21.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T14:50:14.000Z (over 1 year ago)
- Last Synced: 2024-10-29T15:46:33.988Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 489
- Watchers: 9
- Forks: 26
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-nodejs-cn - filenamify - 将字符串转换为有效的文件名 (包 / 文件系统)
- awesome-nodejs - filenamify - Convert a string to a valid filename.  (Repository / Filesystem)
- awesome-nodejs-cn - filenamify - **star:489** 将字符串转换为有效的文件名 (包 / 文件系统)
- awesome-nodejs - filenamify - Convert a string to a valid filename. (Packages / Filesystem)
- awesome-nodejs - filenamify - Convert a string to a valid safe filename - ★ 183 (Filesystem)
- awesome-node - filenamify - Convert a string to a valid filename. (Packages / Filesystem)
- awesome-nodejs-cn - filenamify - 将字符串转换为有效的文件名. (目录 / 文件系统)
- awesome-nodejs - filenamify - 将字符串转换为有效的安全文件名 (Uncategorized / Uncategorized)
README
# filenamify
> Convert a string to a valid safe filename
On Unix-like systems, `/` is reserved. On Windows, [`<>:"/\|?*`](http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29#naming_conventions) along with trailing periods are reserved.
## Install
```sh
npm install filenamify
```
## Usage
```js
import filenamify from 'filenamify';
filenamify('');
//=> '!foo!bar!'
filenamify('foo:"bar"', {replacement: '🐴'});
//=> 'foo🐴bar🐴'
```
## API
### filenamify(string, options?)
Convert a string to a valid filename.
### filenamifyPath(path, options?)
Convert the filename in a path a valid filename and return the augmented path.
```js
import {filenamifyPath} from 'filenamify';
filenamifyPath('foo:bar');
//=> 'foo!bar'
```
#### options
Type: `object`
##### replacement
Type: `string`\
Default: `'!'`
String to use as replacement for reserved filename characters.
Cannot contain: `<` `>` `:` `"` `/` `\` `|` `?` `*`
##### maxLength
Type: `number`\
Default: `100`
Truncate the filename to the given length.
Only the base of the filename is truncated, preserving the extension. If the extension itself is longer than `maxLength`, you will get a string that is longer than `maxLength`, so you need to check for that if you allow arbitrary extensions.
Systems generally allow up to 255 characters, but we default to 100 for usability reasons.
## Browser-only import
You can also import `filenamify/browser`, which only imports `filenamify` and not `filenamifyPath`, which relies on `path` being available or polyfilled. Importing `filenamify` this way is therefore useful when it is shipped using `webpack` or similar tools, and if `filenamifyPath` is not needed.
```js
import filenamify from 'filenamify/browser';
filenamify('');
//=> '!foo!bar!'
```
## Related
- [filenamify-cli](https://github.com/sindresorhus/filenamify-cli) - CLI for this module
- [filenamify-url](https://github.com/sindresorhus/filenamify-url) - Convert a URL to a valid filename
- [valid-filename](https://github.com/sindresorhus/valid-filename) - Check if a string is a valid filename
- [unused-filename](https://github.com/sindresorhus/unused-filename) - Get a unused filename by appending a number if it exists
- [slugify](https://github.com/sindresorhus/slugify) - Slugify a string