Skip to content

Commit

Permalink
Docs: toFile expects directory structure to exist
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed Aug 20, 2021
1 parent 17e50de commit 4e84f74
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Note that raw pixel data is only supported for buffer output.
By default all metadata will be removed, which includes EXIF-based orientation.
See [withMetadata][1] for control over this.

The caller is responsible for ensuring directory structures and permissions exist.

A `Promise` is returned when `callback` is not provided.

### Parameters
Expand Down
2 changes: 2 additions & 0 deletions lib/output.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ const errMagickSave = new Error('GIF output requires libvips with support for Im
* By default all metadata will be removed, which includes EXIF-based orientation.
* See {@link withMetadata} for control over this.
*
* The caller is responsible for ensuring directory structures and permissions exist.
*
* A `Promise` is returned when `callback` is not provided.
*
* @example
Expand Down

0 comments on commit 4e84f74

Please sign in to comment.