Skip to content

[Bug]: Docs are inconsistent with typescript collection.delete arguments #5845

@tjkrusinskichroma

Description

@tjkrusinskichroma

What happened?

In the typescript client, the collection interface requires an argument to be passed, even if no properties are provided:

interface Collection {

    /**
     * Deletes records from the collection based on filters.
     * @param args - Deletion criteria
     */
    delete(args: {
        /** Specific record IDs to delete */
        ids?: string[];
        /** Metadata-based filtering for deletion */
        where?: Where;
        /** Document content-based filtering for deletion */
        whereDocument?: WhereDocument;
    }): Promise<void>;
}

However, in the docs, the method is shown as having an optional object argument

Image

Versions

latest

Relevant log output

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions