Skip to content

ExcludeIndexes

@tsed/mongoose

Usage

typescript
import { ExcludeIndexes } from "@tsed/mongoose";

See /packages/orm/mongoose/src/types/decorators/excludeIndexes.ts.

Overview

ts
function ExcludeIndexes(excludeIndexes?: boolean): PropertyDecorator;

Description

If true, Mongoose will skip gathering indexes on subpaths. Only allowed for subdocuments and subdocument arrays.

Example

typescript
@Model()
export class EventModel {
  @ExcludeIndexes()
  field: string;
}

Released under the MIT License.