modelRouter

Call Signature

modelRouter<T>(path, model, options): ModelRouterRegistration

Create a set of CRUD routes given a Mongoose model and configuration options.

When called with a path as the first argument, returns a ModelRouterRegistration that can be passed to TerrenoApp.register().

Type Parameters

T

T

Parameters

path

string

model

ModelLike<T>

options

ModelRouterOptions<T>

Returns

ModelRouterRegistration

Example

// Traditional usage (returns express.Router):
router.use("/todos", modelRouter(Todo, options));

// Registration usage (returns ModelRouterRegistration):
const todoRouter = modelRouter("/todos", Todo, options);
app.register(todoRouter);

Call Signature

modelRouter<T>(model, options): Router

Create a set of CRUD routes given a Mongoose model and configuration options.

When called with a path as the first argument, returns a ModelRouterRegistration that can be passed to TerrenoApp.register().

Type Parameters

T

T

Parameters

model

ModelLike<T>

options

ModelRouterOptions<T>

Returns

Router

Example

// Traditional usage (returns express.Router):
router.use("/todos", modelRouter(Todo, options));

// Registration usage (returns ModelRouterRegistration):
const todoRouter = modelRouter("/todos", Todo, options);
app.register(todoRouter);