# @reis/joi-object-id

> A Joi extension to validation MongoDB ObjectId formats

Latest version **3.0.0** (published 2023-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @reis/joi-object-id
pnpm add @reis/joi-object-id
yarn add @reis/joi-object-id
bun add @reis/joi-object-id
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2023-09-28 |
| First published | 2023-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Adam Reis |
| Maintainers | adamreisnz |
| Keywords | joi, extension, object-id, objectid, mongoose, mongodb |

## Links

- npm: https://www.npmjs.com/package/@reis/joi-object-id
- Repository: https://github.com/adamreisnz/joi-object-id
- Homepage: https://github.com/adamreisnz/joi-object-id#readme
- Issues: https://github.com/adamreisnz/joi-object-id/issues
- npm.io page: https://npm.io/package/@reis/joi-object-id

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 3.0.0 (latest) — 2023-09-28

## README

# @reis/joi-object-id

[![npm version](https://img.shields.io/npm/v/@reis/joi-object-id.svg)](https://www.npmjs.com/package/@reis/joi-object-id)
[![github issues](https://img.shields.io/github/issues/adamreisnz/joi-object-id.svg)](https://github.com/adamreisnz/joi-object-id/issues)


A Joi extension to automatically convert ISO date strings to object-id objects

### Features
- Extends the existing `string` validator
- Validates incoming values as MongoDB ObjectId values
- Automatically converts values to Mongoose `ObjectId` instances

### Installation

```shell
#npm
npm install @reis/joi-object-id

#yarn
yarn add @reis/joi-object-id
```

### Usage
```js
import Joi from 'joi'
import JoiObjectId from '@reis/joi-object-id'

export default Joi.extend(JoiObjectId)
```

### Examples

```js
const schema = Joi.object({
  userId: Joi.string().objectId(),
});
```

## Issues & feature requests

Please report any bugs, issues, suggestions and feature requests in the [joi-object-id issue tracker](https://github.com/adamreisnz/joi-object-id/issues).

## License

(MIT License)

Copyright 2019-2023, Adam Reis

---
_Source: https://npm.io/package/@reis/joi-object-id · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._