Skip to content

Commit

Permalink
Fix missing export of the Options type
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Aug 26, 2021
1 parent 127d797 commit fbb7353
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
10 changes: 10 additions & 0 deletions filenamify-path.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,15 @@ import {Options} from './filenamify.js';

/**
Convert the filename in a path a valid filename and return the augmented path.
@example
```
import {filenamifyPath} from 'filenamify';
filenamifyPath('foo:bar');
//=> 'foo!bar'
```
*/
export default function filenamifyPath(path: string, options?: Options): string;

export {Options} from './filenamify.js';
1 change: 1 addition & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export {default} from './filenamify.js';
export * from './filenamify.js';
export {default as filenamifyPath} from './filenamify-path.js';
7 changes: 7 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ Convert a string to a valid filename.

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`
Expand Down

0 comments on commit fbb7353

Please sign in to comment.