Function deleteById

  • Delete a document by id

    Throws

    mongoose error

    Example

    import { deleteById } from '@mdazad/common-utils';
    import { User } from '../models/user';

    const deleteUser = async (req, res) => {
    await deleteById(req.params.id, User);
    }

    Parameters

    • id: string

      id of the document

    • model: Model<Document<any, any, any>, {}, {}, {}, any>

      mongoose model

    Returns Promise<undefined | true>

    true if deleted successfully

Generated using TypeDoc