@suluk/drizzle - v0.1.6
    Preparing search index...

    Interface CrudOptions

    interface CrudOptions {
        basePath?: string;
        idParam?: string;
        listQuery?: boolean | ListQueryOptions;
        softDelete?: boolean | { column?: string };
        anonymizeDelete?: { columns: string[] };
    }
    Index

    Properties

    basePath? idParam? listQuery? softDelete? anonymizeDelete?

    Properties

    basePath?: string

    Base path for the collection. Default "/" + tableName, e.g. "/users".

    idParam?: string

    Path-param name for the item id. Default "id" ⇒ ".../:id".

    listQuery?: boolean | ListQueryOptions

    Declare list query params (page/perPage/sort/order/q) on the list route. Default true; pass options to scope.

    softDelete?: boolean | { column?: string }

    SOFT delete: DELETE marks the row (sets a deletedAt column) instead of removing it, so the projected DELETE returns the affected row (200), not 204. The patch is built at runtime by softDeleteValues.

    anonymizeDelete?: { columns: string[] }

    ANONYMIZE on delete (GDPR keep-record): DELETE redacts these columns instead of removing the row. Like softDelete, the projected DELETE returns the affected row (200). The patch comes from anonymizeValues.

    Settings

    Member Visibility

    On This Page

    Properties