Class VirtualType<HydratedDocType>

Type Parameters

HydratedDocType

Hierarchy

VirtualType

Index

Constructors

constructor

Methods

Constructors

constructor

new VirtualType<HydratedDocType>(): VirtualType<HydratedDocType>

Type Parameters
- HydratedDocType
Returns VirtualType<HydratedDocType>

Methods

applyGetters

applyGetters(value: any, doc: <internal>.Document<any, any, any>): any

- Defined in node_modules/mongoose/types/index.d.ts:474
Applies getters to value.

Parameters
- value: any
- doc: <internal>.Document<any, any, any>
Returns any

applySetters

applySetters(value: any, doc: <internal>.Document<any, any, any>): any

- Defined in node_modules/mongoose/types/index.d.ts:477
Applies setters to value.

Parameters
- value: any
- doc: <internal>.Document<any, any, any>
Returns any

get

get<T>(fn: ((this: T, value: any, virtualType: VirtualType<T>, doc: T) => any)): VirtualType<HydratedDocType>

- Defined in node_modules/mongoose/types/index.d.ts:480
Adds a custom getter to this virtual.

Type Parameters
- T = HydratedDocType
Parameters
- fn: ((this: T, value: any, virtualType: VirtualType<T>, doc: T) => any)
  - - (this: T, value: any, virtualType: VirtualType<T>, doc: T): any
    - Parameters
      - this: T
      - value: any
      - virtualType: VirtualType<T>
      - doc: T
      Returns any
Returns VirtualType<HydratedDocType>

set

set<T>(fn: ((this: T, value: any, virtualType: VirtualType<T>, doc: T) => void)): VirtualType<HydratedDocType>

- Defined in node_modules/mongoose/types/index.d.ts:483
Adds a custom setter to this virtual.

Type Parameters
- T = HydratedDocType
Parameters
- fn: ((this: T, value: any, virtualType: VirtualType<T>, doc: T) => void)
  - - (this: T, value: any, virtualType: VirtualType<T>, doc: T): void
    - Parameters
      - this: T
      - value: any
      - virtualType: VirtualType<T>
      - doc: T
      Returns void
Returns VirtualType<HydratedDocType>

Generated using TypeDoc