Open Bug 1743412 Opened 2 years ago Updated 1 year ago

IOUtils docs' removeDir example could be more analogous

Categories

(Toolkit :: IOUtils and PathUtils, task)

task

Tracking

()

People

(Reporter: chutten, Unassigned)

References

Details

aminomancer notices:

I think this section should be edited to make the examples actually analogous. OS.File version says:

await OS.File.removeDir(path, { ignoreAbsent: true });

but IOUtils version says:

await IOUtils.remove(path, { recursive: true });

But this method does support ignoreAbsent. The IOUtils version should say:

await IOUtils.remove(path, { ignoreAbsent: true });

The difference is that OS.File.removeDir doesn't have a recursive property, and conversely, it has an ignorePermissions property that IOUtils.remove doesn't support. Maybe an options section for this method should be listed.

Component: OS.File → IOUtils and PathUtils
You need to log in before you can comment on or make changes to this bug.