Skip to content

Documentation lacking for 'soft-remove' #12251

@richarda23

Description

What was unclear or otherwise insufficient?

Hello
I only discovered about soft-remove as an available method after discussing with an AI code assistant about my requirements for cascading soft-deletes. Searching the typeORM documentation, there is no mention of soft-remove at all, whereas there is some for soft-delete.

soft-remove seems useful in that it supports cascades and event listeners in a way that soft-delete doesn't.

I am happy to put up a PR with some content but it will be based on AI discussion on the topic and the results of my own experimentation. I would much rather there is official documentation than relying on AI to trawl through forums .

Recommended Fix

Add a section in the 'Delete using Query Builder' where softDelete is already documented, with a comparison of the two methods and worked examples.

Additional Context

No response

Are you willing to resolve this issue by submitting a Pull Request?

Yes, I have the time, and I know how to start.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions