Options
All
  • Public
  • Public/Protected
  • All
Menu
class
classdesc

Schema for a conversation with a user

extends

dbBase

Hierarchy

  • dbBase
    • chat

Index

Constructors

constructor

  • new chat(a?: any): chat

Accessors

ModelInstance

  • get ModelInstance(): any
  • Returns any

dataType

  • get dataType(): object
  • Returns object

    • boolean: BooleanConstructor
    • buffer: object
      • constructor: function
        • new __type(str: string, encoding?: string): Buffer
        • new __type(size: number): Buffer
        • new __type(array: Uint8Array): Buffer
        • new __type(arrayBuffer: ArrayBuffer): Buffer
        • new __type(array: any[]): Buffer
        • new __type(buffer: Buffer): Buffer
        • Allocates a new buffer containing the given {str}.

          deprecated

          since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

          Parameters

          • str: string

            String to store in buffer.

          • Optional encoding: string

            encoding to use, optional. Default is 'utf8'

          Returns Buffer

        • Allocates a new buffer of {size} octets.

          deprecated

          since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

          Parameters

          • size: number

            count of octets to allocate.

          Returns Buffer

        • Allocates a new buffer containing the given {array} of octets.

          deprecated

          since v10.0.0 - Use Buffer.from(array) instead.

          Parameters

          • array: Uint8Array

            The octets to store.

          Returns Buffer

        • Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}.

          deprecated

          since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

          Parameters

          • arrayBuffer: ArrayBuffer

            The ArrayBuffer with which to share memory.

          Returns Buffer

        • Allocates a new buffer containing the given {array} of octets.

          deprecated

          since v10.0.0 - Use Buffer.from(array) instead.

          Parameters

          • array: any[]

            The octets to store.

          Returns Buffer

        • Copies the passed {buffer} data onto a new {Buffer} instance.

          deprecated

          since v10.0.0 - Use Buffer.from(buffer) instead.

          Parameters

          • buffer: Buffer

            The buffer to copy.

          Returns Buffer

      • poolSize: number

        This is the number of bytes used to determine the size of pre-allocated, internal Buffer instances used for pooling. This value may be modified.

      • prototype: Buffer
      • alloc: function
        • alloc(size: number, fill?: string | Buffer | number, encoding?: string): Buffer
        • Allocates a new buffer of {size} octets.

          Parameters

          • size: number

            count of octets to allocate.

          • Optional fill: string | Buffer | number

            if specified, buffer will be initialized by calling buf.fill(fill). If parameter is omitted, buffer will be filled with zeros.

          • Optional encoding: string

            encoding used for call to buf.fill while initalizing

          Returns Buffer

      • allocUnsafe: function
        • allocUnsafe(size: number): Buffer
        • Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.

          Parameters

          • size: number

            count of octets to allocate

          Returns Buffer

      • allocUnsafeSlow: function
        • allocUnsafeSlow(size: number): Buffer
        • Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.

          Parameters

          • size: number

            count of octets to allocate

          Returns Buffer

      • byteLength: function
        • byteLength(string: string | ArrayBuffer | ArrayBufferView, encoding?: string): number
        • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

          Parameters

          • string: string | ArrayBuffer | ArrayBufferView

            string to test. (TypedArray is also allowed, but it is only available starting ES2017)

          • Optional encoding: string

            encoding used to evaluate (defaults to 'utf8')

          Returns number

      • compare: function
        • compare(buf1: Uint8Array, buf2: Uint8Array): number
        • The same as buf1.compare(buf2).

          Parameters

          • buf1: Uint8Array
          • buf2: Uint8Array

          Returns number

      • concat: function
        • concat(list: Uint8Array[], totalLength?: number): Buffer
        • Returns a buffer which is the result of concatenating all the buffers in the list together.

          If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

          Parameters

          • list: Uint8Array[]

            An array of Buffer objects to concatenate

          • Optional totalLength: number

            Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

          Returns Buffer

      • from: function
        • from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer
        • from(data: any[]): Buffer
        • from(data: Uint8Array): Buffer
        • from(str: string, encoding?: string): Buffer
        • When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share the same allocated memory as the TypedArray. The optional {byteOffset} and {length} arguments specify a memory range within the {arrayBuffer} that will be shared by the Buffer.

          Parameters

          • arrayBuffer: ArrayBuffer

            The .buffer property of any TypedArray or a new ArrayBuffer()

          • Optional byteOffset: number
          • Optional length: number

          Returns Buffer

        • Creates a new Buffer using the passed {data}

          Parameters

          • data: any[]

            data to create a new Buffer

          Returns Buffer

        • Parameters

          • data: Uint8Array

          Returns Buffer

        • Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.

          Parameters

          • str: string
          • Optional encoding: string

          Returns Buffer

      • isBuffer: function
        • isBuffer(obj: any): boolean
        • Returns true if {obj} is a Buffer

          Parameters

          • obj: any

            object to test.

          Returns boolean

      • isEncoding: function
        • isEncoding(encoding: string): boolean | undefined
        • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

          Parameters

          • encoding: string

            string to test.

          Returns boolean | undefined

      • of: function
        • of(...items: number[]): Buffer
        • Creates a new Buffer using the passed {data}

          Parameters

          • Rest ...items: number[]

          Returns Buffer

    • date: DateConstructor
    • double: NumberConstructor
    • integer: NumberConstructor
    • mixed: Mixed
    • objectId: ObjectId
    • string: StringConstructor
    • text: StringConstructor

Static mongoose

  • get mongoose(): any
  • Returns any

Methods

aggregate

  • aggregate(param: any): Promise<Object>
  • Parameters

    • param: any

    Returns Promise<Object>

aggregateAndPopulate

  • aggregateAndPopulate(param: any, populate: any, model: any): Promise<Object>
  • Parameters

    • param: any
    • populate: any
    • model: any

    Returns Promise<Object>

count

  • count(param: any): Promise<Object>
  • Parameters

    • param: any

    Returns Promise<Object>

create

  • create(data: any): Promise<Object>
  • Parameters

    • data: any

    Returns Promise<Object>

dropCollection

  • dropCollection(): Promise<any>
  • Returns Promise<any>

find

  • find(param: any, projection?: any, option?: any): Promise<Object>
  • Parameters

    • param: any
    • Optional projection: any
    • Optional option: any

    Returns Promise<Object>

findAll

  • findAll(projection?: any, option?: any): Promise<Object>
  • Parameters

    • Optional projection: any
    • Optional option: any

    Returns Promise<Object>

findAndPopulate

  • findAndPopulate(param: any, populate: any, projection: any, options?: any): Promise<Object>
  • Parameters

    • param: any
    • populate: any
    • projection: any
    • Optional options: any

    Returns Promise<Object>

findByPrimaryKey

  • findByPrimaryKey(value: any, projection?: any, option?: any): Promise<Object>
  • Parameters

    • value: any
    • Optional projection: any
    • Optional option: any

    Returns Promise<Object>

findOne

  • findOne(param: any, projection?: any, option?: any): Promise<Object>
  • Parameters

    • param: any
    • Optional projection: any
    • Optional option: any

    Returns Promise<Object>

isExists

  • isExists(param: any): Promise<Object>
  • Parameters

    • param: any

    Returns Promise<Object>

isUnique

  • isUnique(columnName: any, columnValue: any): Promise<Object>
  • Parameters

    • columnName: any
    • columnValue: any

    Returns Promise<Object>

Protected log

  • log(message: string): void
  • Parameters

    • message: string

    Returns void

remove

  • remove(param: any): Promise<Object>
  • Parameters

    • param: any

    Returns Promise<Object>

totalCount

  • totalCount(): Promise<Object>
  • Returns Promise<Object>

truncate

  • truncate(): Promise<Object>
  • Returns Promise<Object>

update

  • update(param: any, data: any, options?: any): Promise<Object>
  • Parameters

    • param: any
    • data: any
    • Optional options: any

    Returns Promise<Object>

updateById

  • updateById(id: any, data: any, options?: any): Promise<Object>
  • Parameters

    • id: any
    • data: any
    • Optional options: any

    Returns Promise<Object>

upsert

  • upsert(param: any, data: any, options?: any): Promise<Object>
  • Parameters

    • param: any
    • data: any
    • Optional options: any

    Returns Promise<Object>

Static validate

  • validate(target: any): void
  • Parameters

    • target: any

    Returns void

Object literals

Private $schema

$schema: object

conversations

conversations: object[] = [{type: { type: this.dataType.string, default: "text" },doc_id: { type: this.dataType.objectId, ref: "doc" },text: this.dataType.string,created_date_time: { type: this.dataType.date, default: Date.now },created_by_user: { type: this.dataType.objectId, ref: "user" },isDropped: { type: this.dataType.boolean, default: false },favorite: [{ type: this.dataType.objectId, ref: "user" }],missed: { type: this.dataType.boolean, default: false },readBy: [{user: { type: this.dataType.objectId, ref: "user" },read_date: { type: this.dataType.date, default: Date.now }}],replyOf: {chat_name: this.dataType.string,chat_id: { type: this.dataType.objectId, ref: "user" },message: this.dataType.string}}]

subject

subject: StringConstructor = this.dataType.string

users

users: object[] = [{ type: this.dataType.objectId, ref: "user" }]

created_by_user

created_by_user: object

ref

ref: string = "user"

type

type: ObjectId = this.dataType.objectId

created_date

created_date: object

default

default: now = Date.now

type

type: DateConstructor = this.dataType.date

isP2PChat

isP2PChat: object

default

default: boolean = false

type

type: BooleanConstructor = this.dataType.boolean

last_access_date

last_access_date: object

default

default: now = Date.now

type

type: DateConstructor = this.dataType.date

Generated using TypeDoc