expressjs/multer

'preservePath:true' is very unclear

Open

#846 opened on Feb 25, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (1,043 forks)batch import
docsenhancementhelp wanted

Repository metrics

Stars
 (11,136 stars)
PR merge metrics
 (Avg merge 9d 11h) (7 merged PRs in 30d)

Description

I wanted to fetch the full path of a file that's being uploaded by the user. I have found about the preservePath option, I have enabled it. But the documentation is so unclear, it's very rudimentary to figure out, where to go from here

Contributor guide

Research direction
Review the current documentation for the 'preservePath' option in multer's README and source code. Identify where the documentation is unclear, such as not explaining how to access the full path after enabling the option. Propose adding a clear example showing how to retrieve the file path from req.file after setting preservePath: true. Ensure the example highlights the difference between the original path and the saved path.
Tech stack
javascriptnodejsexpressrest api
Domain
backendapidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic Node.jsunderstanding of file uploads
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80