Skip to content

docs: clarify preservePath behavior #1414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vibhor-aggr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify preservePath behavior #1414

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Each file contains the following information:
Key | Description | Note
--- | --- | ---
`fieldname` | Field name specified in the form |
`originalname` | Name of the file on the user's computer |
`originalname` | Name of the file on the user's computer, or the full path when `preservePath: true` |
`encoding` | Encoding type of the file |
`mimetype` | Mime type of the file |
`size` | Size of the file in bytes |
Expand All @@ -145,7 +145,7 @@ Key | Description
`dest` or `storage` | Where to store the files
`fileFilter` | Function to control which files are accepted
`limits` | Limits of the uploaded data
`preservePath` | Keep the full path of files instead of just the base name
`preservePath` | Keep the full client-supplied path in `file.originalname` instead of just the base name
`defParamCharset` | Default character set to use for values of part header parameters (e.g. filename) that are not extended parameters (that contain an explicit charset). Default: `'latin1'`

In an average web app, only `dest` might be required, and configured as shown in
Expand All @@ -155,6 +155,13 @@ the following example.
const upload = multer({ dest: 'uploads/' })
```

When `preservePath` is enabled, Multer passes the incoming filename through with
any path segments provided by the client. This is exposed as `file.originalname`;
it does not change the destination folder, create directories, or sanitize the
path for you. Treat `file.originalname` as untrusted input if you use it in a
custom `filename` or storage engine, and normalize or validate it before writing
to disk.

If you want more control over your uploads, you'll want to use the `storage`
option instead of `dest`. Multer ships with storage engines `DiskStorage`
and `MemoryStorage`; More engines are available from third parties.
Expand Down