How to check if string is of type ObjectId in Node.js

Question

I have a route /api/:id where :id has to be of type ObjectId. Because following is the query I am runnuing

const data = await Person.find({_id:req.params.id})

It works fine if :id is of type ObjectId but if user explicitly runs the api lets say /api/anything, then Mongoose throughs an error

CastError: Cast to ObjectId failed for value "anything" at path "_id"

So, I would like to check if req.params.id is of type ObjectId and perform further operations only if it is.

Thus code would look like

if(checkObjectId(req.params.id)) {
const data = await Person.find({_id:req.params.id})
}

Maybe this will help? stackoverflow.com/questions/13850819/… — Ihor Vyspiansky
– Ihor Vyspiansky, Commented Aug 28, 2020 at 6:22
I'd combine the express param regex validation (e.g. /api/:id(\d+)) with a good regex that matches the ObjectId, e.g [a-f\d]{24} here. That would mean api/:id([a-f\d]{24}) should do here. — Wiktor Zychla
– Wiktor Zychla, Commented Aug 28, 2020 at 6:27

Ionică Bizău · Accepted Answer · 2020-08-28 06:22:31Z

2

Use the Mongoose functionality:

if(mongoose.isValidObjectId(req.params.id)) {
  const data = await Person.find({_id:req.params.id})
  ...
}

Mongoose.prototype.isValidObjectId()

Returns true if Mongoose can cast the given value to an ObjectId, or false otherwise.
mongoose.isValidObjectId(new mongoose.Types.ObjectId()); // true
mongoose.isValidObjectId('0123456789ab'); // true
mongoose.isValidObjectId(6); // false

answered Aug 28, 2020 at 6:22

Ionică Bizău

114k95 gold badges311 silver badges490 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Amir Mohammad Beheshti · Accepted Answer · 2023-01-31 10:33:10Z

2

you can use isValid method for validate object id

mongoose.Types.ObjectId.isValid('63d632828e944c3a08f15925')

answered Jan 31, 2023 at 10:33

Amir Mohammad Beheshti

1549 bronze badges

Comments

Aidil · Accepted Answer · 2020-08-28 06:32:42Z

0

Why if when you can use try ... catch

let data;
try {
    data = await Person.find({_id:req.params.id})
} catch(err) {
    console.log('Error retrieving data (Person):', err);
}

answered Aug 28, 2020 at 6:32

Aidil

1011 silver badge7 bronze badges

1 Comment

Ranjeet Eppakayala Over a year ago

Thats not the way of checking :)

Collectives™ on Stack Overflow

How to check if string is of type ObjectId in Node.js

3 Answers 3

`Mongoose.prototype.isValidObjectId()`

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related