Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SchemaType<T, DocType>

Type Parameters

  • T = any

  • DocType = any

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

  • new SchemaType<T, DocType>(path: string, options?: AnyObject, instance?: string): SchemaType<T, DocType>

  • SchemaType constructor

    Type Parameters

    • T = any

    • DocType = any

    Parameters

    • path: string
    • Optional options: AnyObject
    • Optional instance: string

    Returns SchemaType<T, DocType>

Methods

Static cast

  • cast(caster?: boolean | Function): 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: any) => boolean)): ((v: any) => boolean)

  • Parameters

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

        • Parameters

          • v: any

          Returns boolean

    Returns ((v: any) => boolean)

      • (v: any): boolean

      • Parameters

        • v: any

        Returns boolean

Static set

  • set(option: string, value: any): void

  • Sets a default option for this schema type.

    Parameters

    • option: string
    • value: any

    Returns void

Static get

  • get(getter: ((value: any) => any)): void

  • Attaches a getter for all instances of this schema type.

    Parameters

    • getter: ((value: any) => any)
        • (value: any): any

        • Parameters

          • value: any

          Returns any

    Returns void

cast

  • cast(val: any, doc: <internal>.Document<any, any, any>, init: boolean, prev?: any, options?: any): any

  • Cast val to this schema type. Each class that inherits from schema type should implement this function.

    Parameters

    • val: any
    • doc: <internal>.Document<any, any, any>
    • init: boolean
    • Optional prev: any
    • Optional options: any

    Returns any

default

  • default(val: any): any

  • Sets a default value for this SchemaType.

    Parameters

    • val: any

    Returns any

get

  • Adds a getter to this schematype.

    Parameters

    • fn: Function

    Returns SchemaType<T, DocType>

immutable

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

    Parameters

    • bool: boolean

    Returns SchemaType<T, DocType>

index

  • Declares the index options for this schematype.

    Parameters

    • options: any

    Returns SchemaType<T, DocType>

ref

  • 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

    Returns SchemaType<T, DocType>

required

  • required(required: boolean, message?: string): SchemaType<T, DocType>

  • 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 SchemaType<T, DocType>

select

  • Sets default select() behavior for this path.

    Parameters

    • val: boolean

    Returns SchemaType<T, DocType>

set

  • Adds a setter to this schematype.

    Parameters

    • fn: Function

    Returns SchemaType<T, DocType>

sparse

  • Declares a sparse index.

    Parameters

    • bool: boolean

    Returns SchemaType<T, DocType>

text

  • Declares a full text index.

    Parameters

    • bool: boolean

    Returns SchemaType<T, DocType>

transform

  • transform(fn: ((value: any) => any)): SchemaType<T, DocType>

  • Defines a custom function for transforming this path when converting a document to JSON.

    Parameters

    • fn: ((value: any) => any)
        • (value: any): any

        • Parameters

          • value: any

          Returns any

    Returns SchemaType<T, DocType>

unique

  • Declares an unique index.

    Parameters

    • bool: boolean

    Returns SchemaType<T, DocType>

validate

  • validate(obj: RegExp | ((this: DocType, value: any, validatorProperties?: Validator) => any), errorMsg?: string, type?: string): SchemaType<T, DocType>

  • Adds validator(s) for this document path.

    Parameters

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

    Returns SchemaType<T, DocType>

Properties

OptionsConstructor

OptionsConstructor: SchemaTypeOptions<T>

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

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, <internal>.Model<any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}>

The schema this SchemaType instance is part of

validators

validators: Validator[]

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

Optional defaultOptions

defaultOptions?: <internal>.Record<string, any>

Default options for this SchemaType

Generated using TypeDoc