Module "schema"

Index

Type aliases

Functions

Type aliases

LazyClass

LazyClass: () => Constructor

Type declaration

- (): Constructor
- Returns Constructor

SchemaType

SchemaType<T>: Omit<SchemaTypeOpts<T>, "type"> & { type?: T }

Type parameters

T

Functions

array

array<T>(type?: T, options?: SchemaTypeOpts<T[]>): (Anonymous function)

- Defined in src/schema.ts:23
Type parameters
- T: unknown
Parameters
- Optional type: T
- Optional options: SchemaTypeOpts<T[]>
Returns (Anonymous function)

defaults

defaults<T>(value: T): PropertyDecorator

- Defined in src/schema.ts:70
Type parameters
- T
Parameters
- value: T
Returns PropertyDecorator

enums

enums(values: Array<string | number> | Record<string | number, string | number>): PropertyDecorator

- Defined in src/schema.ts:82
Parameters
- values: Array<string | number> | Record<string | number, string | number>
Returns PropertyDecorator

hidden

hidden(): PropertyDecorator

- Defined in src/schema.ts:58
Returns PropertyDecorator

id

id(): PropertyDecorator

- Defined in src/schema.ts:42
Returns PropertyDecorator

indexed

indexed(): PropertyDecorator

- Defined in src/schema.ts:52
Returns PropertyDecorator

methods

methods(): PropertyDecorator

- Defined in src/schema.ts:190
Returns PropertyDecorator

mongoId

mongoId<T>(options?: SchemaTypeOpts<T> & { type?: T }, type?: T): PropertyDecorator

- Defined in src/schema.ts:207
Type parameters
- T
Parameters
- Default value options: SchemaTypeOpts<T> & { type?: T } = {}
- Optional type: T
Returns PropertyDecorator

prop

prop<T>(options?: SchemaType<T>, type?: SchemaDefinition["type"]): PropertyDecorator

- Defined in src/schema.ts:8
Type parameters
- T
Parameters
- Default value options: SchemaType<T> = {}
- Optional type: SchemaDefinition["type"]
Returns PropertyDecorator

query

query(): PropertyDecorator

- Defined in src/schema.ts:184
Returns PropertyDecorator

ref

ref(nameOrClass: string | LazyClass, idType: unknown): any
ref(nameOrClass: IMongooseClass, idType?: unknown): any

- Defined in src/schema.ts:93
Parameters
- nameOrClass: string | LazyClass
- idType: unknown
Returns any
- Defined in src/schema.ts:94
Parameters
- nameOrClass: IMongooseClass
- Optional idType: unknown
Returns any

refArray

refArray(nameOrClass: string | LazyClass | IMongooseClass, elementType: unknown): PropertyDecorator

- Defined in src/schema.ts:142
Parameters
- nameOrClass: string | LazyClass | IMongooseClass
- elementType: unknown
Returns PropertyDecorator

required

required(): PropertyDecorator

- Defined in src/schema.ts:46
Returns PropertyDecorator

statics

statics(): PropertyDecorator

- Defined in src/schema.ts:178
Returns PropertyDecorator

type

type(type: Prototype): PropertyDecorator

- Defined in src/schema.ts:76
Parameters
- type: Prototype
Returns PropertyDecorator

unique

unique(): PropertyDecorator

- Defined in src/schema.ts:64
Returns PropertyDecorator

virtual

virtual(): MethodDecorator

- Defined in src/schema.ts:196
Returns MethodDecorator

Generated using TypeDoc