mongoose-schema-ts-infer v0.1.19

What does it do and why?

mongoose has typescript support since v5.11.0.

But until mongoose@>=6.3.1, everytime we create a schema, we must create an interface representing a document in MongoDB.

This library has been made for these people 😁: Create your schema and infer the document type from it!

Install

npm i mongoose-schema-ts-infer

Usage

1. Create a mongoose schema:

const userSchema = {
  name: {
    type: String, 
    required: true as const
  },
  email: String,
  favoriteColor: {
    type: String, 
    required: false as const, 
    enum: ['white', 'black'] as const
  },
}

Warning as const is mandatory for required option, enum option and type (if it's a string like "buffer", "Buffer", etc...).

2. Infer a document type from it:

import {InferFromSchema} from "mongoose-schema-ts-infer";

type IUser = InferFromSchema<typeof userSchema>;

/**
 * `IUser` type is equivalent to:
 * { 
 *     _id ?: ObjectId
 *     name: string, 
 *     email?: string
 *     favoriteColor?: 'white'|'black
 * }
**/


const document: IUser = {
  name: 'Nicolas',
  favoriteColor: 'white'
}

Supported types

We don't support (yet) all the types. They will come! Feel free to create MR to add if you are in the hurry 😁.

Both shorthand notation ({name: String}) and "classic" notation ({name: {type: String}}) are supported. For the latter, some options are also taken into account:

Examples

All examples are available in the "examples" folder:

• The basics
• enum option
• array
• nested schema
• Map
• Sub document/schema

Test, transpile and publish on npm

Before publishing, we need to transpile the code into lib and make sure everything works:

npm test && npm run build

For publishing on npm (make sure to update the version in package.json first):

npm publish