Class DocumentArray

Hierarchy (view full)

Implements

Constructors

constructor

Properties

OptionsConstructor caster? defaultOptions instance isRequired? options path schema validators options schemaName

Methods

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

Constructors

constructor

Properties

OptionsConstructor

OptionsConstructor: SchemaTypeOptions<any, any>

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

Optional caster

caster?: typeof mongoose.Schema.Types.Subdocument

The constructor used for subdocuments 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 used for documents in this array

Type declaration

    Type declaration

      Type declaration

        Type declaration

          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: "DocumentArray"

            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 options: any

              Returns any

            default

            • default(val): any

            • Sets a default value for this SchemaType.

              Parameters

              • val: any

              Returns any

            discriminator

            get

            • get(fn): this

            • Adds a getter to this schematype.

              Parameters

              • fn: Function

              Returns this

            immutable

            • immutable(bool): this

            • Defines this path as immutable. Mongoose prevents you from changing immutable paths unless the parent document has isNew: true.

              Parameters

              • bool: boolean

              Returns this

            index

            • index(options): this

            • Declares the index options for this schematype.

              Parameters

              • options: any

              Returns this

            ref

            • ref(ref): this

            • 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 this

            required

            • required(required, message?): this

            • 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

              Returns this

            select

            • select(val): this

            • Sets default select() behavior for this path.

              Parameters

              • val: boolean

              Returns this

            set

            • set(fn): this

            • Adds a setter to this schematype.

              Parameters

              • fn: Function

              Returns this

            sparse

            • sparse(bool): this

            • Declares a sparse index.

              Parameters

              • bool: boolean

              Returns this

            text

            • text(bool): this

            • Declares a full text index.

              Parameters

              • bool: boolean

              Returns this

            transform

            • transform(fn): this

            • 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 this

            unique

            • unique(bool): this

            • Declares an unique index.

              Parameters

              • bool: boolean

              Returns this

            validate

            • validate(obj, errorMsg?, type?): this

            • Adds validator(s) for this document path.

              Parameters

              • obj: RegExp | ((this, value, validatorProperties?) => any)
              • Optional errorMsg: string
              • Optional type: string

              Returns this

            Static cast

            • cast(caster?): Function

            • Get/set the function used to cast arbitrary values to this type.

              Parameters

              • Optional caster: boolean | Function

              Returns Function

            Static checkRequired

            • checkRequired(checkRequired?): ((v) => boolean)

            • Parameters

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

                  • Parameters

                    • v: any

                    Returns boolean

              Returns ((v) => boolean)

                • (v): boolean

                • Parameters

                  • v: any

                  Returns boolean

            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

            Static set

            • set(option, value): void

            • Sets a default option for this schema type.

              Parameters

              • option: string
              • value: any

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            constructorOptionsConstructorcasterdefaultOptionsinstanceisRequiredoptionspathschemavalidatorsoptionsschemaNamecastdefaultdiscriminatorgetimmutableindexrefrequiredselectsetsparsetexttransformuniquevalidatecastcheckRequiredgetset