Function updateByIdAndSendResponse

  • Update a document by id and send response

    Throws

    mongoose error

    Example

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

    const router = express.Router();

    router.put("/:id", async (req, res) => {
    await updateByIdAndSendResponse(req, res, User, { name: 'John Doe' });
    });

    Example

    if you want to populate fields in response

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

    const router = express.Router();

    router.put("/:id", async (req, res) => {
    await updateByIdAndSendResponse(req, res, User, { name: 'John Doe' }, ['posts']);
    });

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      express request

    • res: Response<any, Record<string, any>>

      express response

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

      mongoose model

    • data: any

      data to update

    • populateFields: string[] = []

      fields to populate

    Returns Promise<void>

    updated document in response if found

Generated using TypeDoc