Add ability to easily cleanup

[sindresorhus]

Offer both cleanup when the process exits, manual cleanup method call, and also a context-based cleanup, for examples:

tempy.context(directory => {
	// Use the temp
});

// Temp directory is cleaned up here.

(The temp directory is cleaned up after the callback scope.)
(The above is just an idea. Please consider a better API and naming.)
(The context callback should also be able to be an async function.)

Inspiration: Python Context Managers

---

If you decide to work on this, please put a good effort into the implementation, docs (and TS definition), and tests.

---

IssueHunt Summary

richienb has been rewarded.

Backers (Total: $80.00)

• issuehunt ($80.00)

Submitted pull Requests

• #12 Add cleanup methods
• #15 feat: implement context and contextSync
• #25 Add cleanup methods

---

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

[IssueHuntBot]

@IssueHunt has funded $80.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[Richienb]

@sindresorhus Maybe all the functions could accept an option that make it return an array with the original result and a cleanup method.

const tempy = require("tempy");

const [tempFile, cleanup] = tempy.file({cleanup: true});

// Use tempFile...

cleanup()

We could also add a .task or .cleanable function into all of them:

const tempy = require("tempy");

const [tempFile, cleanup] = tempy.file.cleanable();

// Use tempFile...

cleanup()

We could also stick with a callback-like method like in the original proposal:

const tempy = require("tempy");

tempy.file.task(tempFile => {
	// Use tempFile...
});

I think either of these strategies works best since they are all simple to understand.

[sindresorhus]

The first suggestion is not desirable as it would complicate the TS types and it would be better to just add a .cleanup() method:

const tempy = require("tempy");

const tempFile = tempy.file();

// Use tempFile...

tempy.cleanup(tempFile);

The second suggestion would also not be better than what's above.

I think the last suggestion there is the best.

[Richienb]

@sindresorhus Would it also be useful to remove temporary content when the process is killed?

[sindresorhus]

Yes, but ignoring any failure.

[Richienb]

@sindresorhus exit-hook gets us most of the way, we just need to detect when an error is a reason for exiting. https://stackoverflow.com/a/23197430/8384910

[issuehunt-oss]

@sindresorhus has rewarded $72.00 to @richienb. See it on IssueHunt

• 💰 Total deposit: $80.00
• 🎉 Repository reward(0%): $0.00
• 🔧 Service fee(10%): $8.00