Options
All
  • Public
  • Public/Protected
  • All
Menu

@fiquu/schema-loader-mongoose

Build Status GitHub GitHub last commit npm (scoped) npm

Schema loader for Mongoose connections.

Installation

npm i @fiquu/schema-loader-mongoose

Usage

Use it to load your schemas into any Mongoose connection.

./configs/schemas.ts:

import { SchemasMap, SchemaLoaderOptions } from '@fiquu/schema-loader-mongoose';

// You could move the schema map to another sub-module...
import profile from '../schemas/profile';
import user from '../schemas/user';

const schemas: SchemasMap = new Map();

schemas.set('profile', profile);
schemas.set('user', user);

const options: SchemaLoaderOptions = {
  replace: false,
  clone: true
};

export default {
  schemas,
  options
}

./components/schemas.ts:

import { createSchemaLoader, SchemaLoader } from '@fiquu/schema-loader-mongoose';
import { Connection } from 'mongoose';

import { options, schemas } from '../configs/schemas';
import db from '../components/database';

const conn: Connection = db.connection('default');
const loader: SchemaLoader = createSchemaLoader(conn, options);

loader.loadAll(schemas);

export default loader;

Documentation

Please visit the documentation page for more info and options.

Index

Type aliases

SchemasMap

SchemasMap: Map<string, Schema>

Functions

Const createSchemaLoader

  • Creates a new schema loader instance.

    Parameters

    • connection: Connection

      The connection to use.

    • Optional options: SchemaLoaderOptions

      The options object.

    Returns SchemaLoader

    The schema loader instance.

Legend

  • Property
  • Method

Generated using TypeDoc