-
Notifications
You must be signed in to change notification settings - Fork 29.9k
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.
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
doc: Please explain what "pathObject" is #36582
Comments
Or, hm, I expected a class object, but it seems to be just a {} style object. Please make it more clear. |
How could we make it clearer? Do you have any suggestions? |
@aduh95 BTW, I see this under "pathObject": "Returns: <string>". That looks wrong. |
I don't think that's wrong, the function does return a string.. $ node -p "path.format({dir: '/home/user/dir', base: 'file.txt'})"
/home/user/dir/file.txt Do you see something else? |
@aduh95 Eh, sorry. You are right. |
Maybe "any JavaScript object which has the following keys:". |
Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: nodejs#36582
📗 API Reference Docs Problem
Location
https://nodejs.org/api/path.html#path_path_format_pathobject
Description
I can't see any reference to what "pathObject" is (or how to create it).
The text was updated successfully, but these errors were encountered: