Function isValidObjectId

  • isValidObjectId(id: string): boolean

    Validates if a string is a valid MongoDB ObjectID

    MongoDB ObjectIDs are 24-character hexadecimal strings that serve as unique identifiers for documents in collections. This function validates the format and structure of ObjectID strings.

    Parameters

    • id: string

      The string to validate as an ObjectID

    Returns boolean

    True if the string is a valid ObjectID, false otherwise

    Example

    Valid ObjectIDs:

    isValidObjectId('507f1f77bcf86cd799439011'); // true
    isValidObjectId('507f1f77bcf86cd799439012'); // true
    isValidObjectId('507f1f77bcf86cd799439013'); // true

    Example

    Invalid ObjectIDs:

    isValidObjectId('invalid-id'); // false
    isValidObjectId('123'); // false
    isValidObjectId('507f1f77bcf86cd79943901'); // false (23 chars)
    isValidObjectId('507f1f77bcf86cd7994390111'); // false (25 chars)
    isValidObjectId('507f1f77bcf86cd79943901g'); // false (invalid char)

    Example

    Usage in validation:

    function validateUserId(userId: string): boolean {
      if (!isValidObjectId(userId)) {
        throw new Error('Invalid user ID format');
      }
      return true;
    }

Settings

Member Visibility