Class VirtualType<HydratedDocType>

Type Parameters

HydratedDocType

Hierarchy

VirtualType

Index

Constructors

constructor

Methods

applyGetters applySetters get set

Constructors

constructor

new VirtualType<HydratedDocType>(): VirtualType<HydratedDocType>
Type Parameters
- HydratedDocType
Returns VirtualType<HydratedDocType>

Methods

applyGetters

applyGetters(value, doc): any
Applies getters to value.
Parameters
- value: any
- doc: mongoose.Document<any, any, any>
Returns any
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/index.d.ts:578

applySetters

applySetters(value, doc): any
Applies setters to value.
Parameters
- value: any
- doc: mongoose.Document<any, any, any>
Returns any
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/index.d.ts:581

get

get<T>(fn): VirtualType<HydratedDocType>
Adds a custom getter to this virtual.
Type Parameters
- T = HydratedDocType
Parameters
- fn: ((this, value, virtualType, doc) => any)
  - - (this, value, virtualType, doc): any
    - Parameters
      
      this: T
      
      value: any
      
      virtualType: VirtualType<T>
      
      doc: T
      
      Returns any
Returns VirtualType<HydratedDocType>
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/index.d.ts:584

set

set<T>(fn): VirtualType<HydratedDocType>
Adds a custom setter to this virtual.
Type Parameters
- T = HydratedDocType
Parameters
- fn: ((this, value, virtualType, doc) => void)
  - - (this, value, virtualType, doc): void
    - Parameters
      
      this: T
      
      value: any
      
      virtualType: VirtualType<T>
      
      doc: T
      
      Returns void
Returns VirtualType<HydratedDocType>
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/index.d.ts:587

Class VirtualType<HydratedDocType>

Type Parameters

HydratedDocType

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

HydratedDocType

Returns VirtualType<HydratedDocType>

Methods

applyGetters

Parameters

value: any

doc: mongoose.Document<any, any, any>

Returns any

applySetters

Parameters

value: any

doc: mongoose.Document<any, any, any>

Returns any

get

Type Parameters

T = HydratedDocType

Parameters

fn: ((this, value, virtualType, doc) => any)

Parameters

this: T

value: any

virtualType: VirtualType<T>

doc: T

Returns any

Returns VirtualType<HydratedDocType>

set

Type Parameters

T = HydratedDocType

Parameters

fn: ((this, value, virtualType, doc) => void)

Parameters

this: T

value: any

virtualType: VirtualType<T>

doc: T

Returns void

Returns VirtualType<HydratedDocType>

Settings

Member Visibility

Theme

On This Page