doc: Please explain what "pathObject" is

[lborgman]

📗 API Reference Docs Problem

Location

https://nodejs.org/api/path.html#path_path_format_pathobject

• https://nodejs.org/api/✍️

Description

I can't see any reference to what "pathObject" is (or how to create it).

[lborgman]

Or, hm, I expected a class object, but it seems to be just a {} style object. Please make it more clear.

[aduh95]

path.format expects an object that have the properties listed in the docs.Nearly all objects in JavaScript are instances of Object, so it doesn't matter how you create it. Here's a few way of doing it:

• using the {} notation,
• creating a custom class
• using the result of path.parse

How could we make it clearer? Do you have any suggestions?

[lborgman]

@aduh95
Just link to a description like the one you wrote here.

BTW, I see this under "pathObject": "Returns: <string>". That looks wrong.

[aduh95]

BTW, I see this under "pathObject": "Returns: ". 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?

[lborgman]

@aduh95 Eh, sorry. You are right.

[lborgman]

Maybe "any JavaScript object which has the following keys:".