Class BigInt

constructor

• new BigInt(path, options?, instance?): BigInt

• SchemaType constructor

  Parameters

  • path: string

  • Optional options: AnyObject

    Optional

  • Optional instance: string

    Optional

  Returns BigInt

OptionsConstructor

instance

Optional isRequired

options

path

schema

validators

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

default

• default(val): any

• Sets a default value for this SchemaType.

  Parameters

  • val: any

  Returns any

get

• get(fn): BigInt

• Adds a getter to this schematype.

  Parameters

  • fn: Function

  Returns BigInt

immutable

• immutable(bool): BigInt

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

  Parameters

  • bool: boolean

  Returns BigInt

index

• index(options): BigInt

• Declares the index options for this schematype.

  Parameters

  • options: any

  Returns BigInt

ref

• ref(ref): BigInt

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

required

• required(required, message?): BigInt

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

select

• select(val): BigInt

• Sets default select() behavior for this path.

  Parameters

  • val: boolean

  Returns BigInt

set

• set(fn): BigInt

• Adds a setter to this schematype.

  Parameters

  • fn: Function

  Returns BigInt

sparse

• sparse(bool): BigInt

• Declares a sparse index.

  Parameters

  • bool: boolean

  Returns BigInt

text

• text(bool): BigInt

• Declares a full text index.

  Parameters

  • bool: boolean

  Returns BigInt

transform

• transform(fn): BigInt

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

unique

• unique(bool): BigInt

• Declares an unique index.

  Parameters

  • bool: boolean

  Returns BigInt

validate

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

• Adds validator(s) for this document path.

  Parameters

  • obj: RegExp | ((this, value, validatorProperties?) => any)

  • Optional errorMsg: string

    Optional

  • Optional type: string

    Optional

  Returns BigInt

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

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

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