Class ObjectId

Hierarchy

SchemaType
- ObjectId

Index

Constructors

Properties

OptionsConstructor defaultOptions instance isRequired? options path schema validators schemaName

Methods

auto cast default get immutable index ref required select set sparse text transform unique validate cast checkRequired get set

Constructors

constructor

new ObjectId(path, options?, instance?): mongoose.Schema.Types.ObjectId
SchemaType constructor
Parameters
- path: string
- Optional options: AnyObject
  Optional
- Optional instance: string
  Optional
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.constructor
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:201

Properties

OptionsConstructor

OptionsConstructor: SchemaTypeOptions<any, any>

The class that Mongoose uses internally to instantiate this SchemaType's options property.

defaultOptions

defaultOptions: Record<string, any>

Default options for this SchemaType

instance

instance: string

String representation of what type this is, like 'ObjectID' or 'Number'

`Optional` isRequired

isRequired?: boolean

True if this SchemaType has a required validator. False otherwise.

options

options: AnyObject

The options this SchemaType was instantiated with

path

path: string

The path to this SchemaType in a Schema.

schema

schema: Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}, mongoose.Document<unknown, {}, FlatRecord<{}>> & FlatRecord<{}> & Required<{
_id: unknown;
}>>

The schema this SchemaType instance is part of

Type declaration

validators

validators: mongoose.Validator[]

The validators that Mongoose should run to validate properties at this SchemaType's path.

`Static` schemaName

schemaName: "ObjectId"

This schema type's name, to defend against minifiers that mangle function names.

Methods

auto

auto(turnOn): mongoose.Schema.Types.ObjectId
Adds an auto-generated ObjectId default if turnOn is true.
Parameters
- turnOn: boolean
Returns mongoose.Schema.Types.ObjectId
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:432

cast

cast(val, doc, init, prev?, options?): any
Cast val to this schema type. Each class that inherits from schema type should implement this function.
Parameters
- val: any
- doc: mongoose.Document<any, any, any>
- init: boolean
- Optional prev: any
  Optional
- Optional options: any
  Optional
Returns any
Inherited from SchemaType.cast
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:218

default

default(val): any
Sets a default value for this SchemaType.
Parameters
- val: any
Returns any
Inherited from SchemaType.default
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:221

get

get(fn): mongoose.Schema.Types.ObjectId
Adds a getter to this schematype.
Parameters
- fn: Function
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.get
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:224

immutable

immutable(bool): mongoose.Schema.Types.ObjectId
Defines this path as immutable. Mongoose prevents you from changing immutable paths unless the parent document has isNew: true.
Parameters
- bool: boolean
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.immutable
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:230

index

index(options): mongoose.Schema.Types.ObjectId
Declares the index options for this schematype.
Parameters
- options: any
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.index
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:233

ref

ref(ref): mongoose.Schema.Types.ObjectId
Set the model that this path refers to. This is the option that populate looks at to determine the foreign collection it should query.
Parameters
- ref: string | boolean | mongoose.Model<any, {}, {}, {}, any, any>
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.ref
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:251

required

required(required, message?): mongoose.Schema.Types.ObjectId
Adds a required validator to this SchemaType. The validator gets added to the front of this SchemaType's validators array using unshift().
Parameters
- required: boolean
- Optional message: string
  Optional
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.required
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:257

select

select(val): mongoose.Schema.Types.ObjectId
Sets default select() behavior for this path.
Parameters
- val: boolean
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.select
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:263

set

set(fn): mongoose.Schema.Types.ObjectId
Adds a setter to this schematype.
Parameters
- fn: Function
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.set
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:266

sparse

sparse(bool): mongoose.Schema.Types.ObjectId
Declares a sparse index.
Parameters
- bool: boolean
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.sparse
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:269

text

text(bool): mongoose.Schema.Types.ObjectId
Declares a full text index.
Parameters
- bool: boolean
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.text
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:272

transform

transform(fn): mongoose.Schema.Types.ObjectId
Defines a custom function for transforming this path when converting a document to JSON.
Parameters
- fn: ((value) => any)
  - - (value): any
    - Parameters
      
      value: any
      
      Returns any
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.transform
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:275

unique

unique(bool): mongoose.Schema.Types.ObjectId
Declares an unique index.
Parameters
- bool: boolean
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.unique
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:278

validate

validate(obj, errorMsg?, type?): mongoose.Schema.Types.ObjectId
Adds validator(s) for this document path.
Parameters
- obj: RegExp | ((this, value, validatorProperties?) => any)
- Optional errorMsg: string
  Optional
- Optional type: string
  Optional
Returns mongoose.Schema.Types.ObjectId
Inherited from SchemaType.validate
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:284

`Static` cast

cast(caster?): Function
Get/set the function used to cast arbitrary values to this type.
Parameters
- Optional caster: boolean | Function
  Optional
Returns Function
Inherited from SchemaType.cast
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:204

`Static` checkRequired

checkRequired(checkRequired?): ((v) => boolean)
Parameters
- Optional checkRequired: ((v) => boolean)
  Optional
  - - (v): boolean
    - Parameters
      
      v: any
      
      Returns boolean
Returns ((v) => boolean)
- - (v): boolean
  - Parameters
    - v: any
    Returns boolean
Inherited from SchemaType.checkRequired
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:206

`Static` get

get(getter): void
Attaches a getter for all instances of this schema type.
Parameters
- getter: ((value) => any)
  - - (value): any
    - Parameters
      
      value: any
      
      Returns any
Returns void
Inherited from SchemaType.get
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:212

`Static` set

set(option, value): void
Sets a default option for this schema type.
Parameters
- option: string
- value: any
Returns void
Inherited from SchemaType.set
- Defined in packages/@biorate/mongodb/node_modules/mongoose/types/schematypes.d.ts:209

Class ObjectId

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

path: string

Optional options: AnyObject

Optional instance: string

Returns mongoose.Schema.Types.ObjectId

Properties

OptionsConstructor

defaultOptions

instance

Optional isRequired

options

path

schema

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

validators

Static schemaName

Methods

auto

Parameters

turnOn: boolean

Returns mongoose.Schema.Types.ObjectId

cast

Parameters

val: any

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

init: boolean

Optional prev: any

Optional options: any

Returns any

default

Parameters

val: any

Returns any

get

Parameters

fn: Function

Returns mongoose.Schema.Types.ObjectId

immutable

Parameters

bool: boolean

Returns mongoose.Schema.Types.ObjectId

index

Parameters

options: any

Returns mongoose.Schema.Types.ObjectId

ref

Parameters

ref: string | boolean | mongoose.Model<any, {}, {}, {}, any, any>

Returns mongoose.Schema.Types.ObjectId

required

Parameters

required: boolean

Optional message: string

Returns mongoose.Schema.Types.ObjectId

select

Parameters

val: boolean

Returns mongoose.Schema.Types.ObjectId

set

Parameters

fn: Function

Returns mongoose.Schema.Types.ObjectId

sparse

Parameters

bool: boolean

Returns mongoose.Schema.Types.ObjectId

text

Parameters

`Optional` options: AnyObject

`Optional` instance: string

`Optional` isRequired

`Static` schemaName

`Optional` prev: any

`Optional` options: any

`Optional` message: string

`Optional` errorMsg: string

`Optional` type: string

`Static` cast

`Optional` caster: boolean | Function

`Static` checkRequired

`Optional` checkRequired: ((v) => boolean)

`Static` get

`Static` set