Class Array

Hierarchy

SchemaType
- Array

Implements

AcceptsDiscriminator

Index

Constructors

constructor

new Array(path, options?, instance?): mongoose.Schema.Types.Array
SchemaType constructor
Parameters
- path: string
- Optional options: AnyObject
  Optional
- Optional instance: string
  Optional
Returns mongoose.Schema.Types.Array
Inherited from SchemaType.constructor
- Defined in node_modules/.pnpm/mongoose@7.8.6/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.

`Optional` caster

caster?: SchemaType<any, any>

The schematype embedded in this array

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` options

options: {
castNonArrays: boolean;
}

Type declaration

castNonArrays: boolean

`Static` schemaName

schemaName: "Array"

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

Methods

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 node_modules/.pnpm/mongoose@7.8.6/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 node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:221

discriminator

discriminator<T, U>(name, schema, value?): U
Adds a discriminator type.
Type Parameters
- T
- U
Parameters
- name: string | number
- schema: Schema<T, U, {}, {}, {}, {}, DefaultSchemaOptions, ObtainDocumentType<any, T, ResolveSchemaOptions<DefaultSchemaOptions>>, IfAny<FlatRecord<ObtainDocumentType<any, T, ResolveSchemaOptions<DefaultSchemaOptions>>>, any, mongoose.Document<unknown, {}, FlatRecord<ObtainDocumentType<any, T, ResolveSchemaOptions<DefaultSchemaOptions>>>> & Require_id<FlatRecord<ObtainDocumentType<any, T, ResolveSchemaOptions<DefaultSchemaOptions>>>>>>
- Optional value: string
  Optional
Returns U
Implementation of AcceptsDiscriminator.discriminator
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:298
discriminator<D>(name, schema, value?): mongoose.Model<D, {}, {}, {}, IfAny<D, any, mongoose.Document<unknown, {}, D> & Require_id<D>>, any>
Type Parameters
- D
Parameters
- name: string | number
- schema: Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}, mongoose.Document<unknown, {}, FlatRecord<{}>> & FlatRecord<{}> & Required<{
  _id: unknown;
  }>>
- Optional value: string
  Optional
Returns mongoose.Model<D, {}, {}, {}, IfAny<D, any, mongoose.Document<unknown, {}, D> & Require_id<D>>, any>
Implementation of AcceptsDiscriminator.discriminator
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:299

enum

enum(vals): mongoose.Schema.Types.Array
Adds an enum validator if this is an array of strings or numbers. Equivalent to SchemaString.prototype.enum() or SchemaNumber.prototype.enum()
Parameters
- vals: string[] | number[]
Returns mongoose.Schema.Types.Array
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:311

get

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

immutable

immutable(bool): mongoose.Schema.Types.Array
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.Array
Inherited from SchemaType.immutable
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:230

index

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

ref

ref(ref): mongoose.Schema.Types.Array
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.Array
Inherited from SchemaType.ref
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:251

required

required(required, message?): mongoose.Schema.Types.Array
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.Array
Inherited from SchemaType.required
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:257

select

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

set

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

sparse

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

text

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

transform

transform(fn): mongoose.Schema.Types.Array
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.Array
Inherited from SchemaType.transform
- Defined in node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:275

unique

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

validate

validate(obj, errorMsg?, type?): mongoose.Schema.Types.Array
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.Array
Inherited from SchemaType.validate
- Defined in node_modules/.pnpm/mongoose@7.8.6/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 node_modules/.pnpm/mongoose@7.8.6/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 node_modules/.pnpm/mongoose@7.8.6/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 node_modules/.pnpm/mongoose@7.8.6/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 node_modules/.pnpm/mongoose@7.8.6/node_modules/mongoose/types/schematypes.d.ts:209

Class Array

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

path: string

Optional options: AnyObject

Optional instance: string

Returns mongoose.Schema.Types.Array

Properties

OptionsConstructor

Optional caster

defaultOptions

instance

Optional isRequired

options

path

schema

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

validators

Static options

Type declaration

castNonArrays: boolean

Static schemaName

Methods

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

discriminator

Type Parameters

T

U

Parameters

name: string | number

Optional value: string

Returns U

Type Parameters

D

Parameters

name: string | number

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

Optional value: string

Returns mongoose.Model<D, {}, {}, {}, IfAny<D, any, mongoose.Document<unknown, {}, D> & Require_id<D>>, any>

enum

Parameters

vals: string[] | number[]

Returns mongoose.Schema.Types.Array

get

Parameters

fn: Function

Returns mongoose.Schema.Types.Array

immutable

Parameters

bool: boolean

Returns mongoose.Schema.Types.Array

index

Parameters

options: any

Returns mongoose.Schema.Types.Array

ref

Parameters

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

`Optional` options: AnyObject

`Optional` instance: string

`Optional` caster

`Optional` isRequired

`Static` options

`Static` schemaName

`Optional` prev: any

`Optional` options: any

`Optional` value: string

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

`Optional` value: string

`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