Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Mapper

Hierarchy

  • AsyncEventEmitter
  • AsyncEventEmitter
    • Mapper

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Hooks ordering:

    Operation(s) Order

    find, findAll afterGet get, getAll beforeGet, afterGet insert,insertAll beforeValidate, afterValidate, beforeInsert, afterInsert, afterGet

    replace, update beforeValidate, afterValidate, beforeUpdate, afterUpdate, afterGet

    Hooks are called on each record, so getAll, findAll, and insertAll operations will call each hook for each record.

    Parameters

    Returns Mapper

  • Hooks ordering:

    Operation(s) Order

    find, findAll afterGet get, getAll beforeGet, afterGet insert,insertAll beforeValidate, afterValidate, beforeInsert, afterInsert, afterGet

    replace, update beforeValidate, afterValidate, beforeUpdate, afterUpdate, afterGet

    Hooks are called on each record, so getAll, findAll, and insertAll operations will call each hook for each record.

    Parameters

    • options: MapperOptions

    Returns Mapper

Properties

adapter

adapter: Adapter

collection

collection: string

listeners

listeners: EventListener[] = []

name

name: string

Static hooksList

hooksList: string[] = ['afterGet','afterInsert','afterUpdate','afterValidate','beforeGet','beforeInsert','beforeUpdate','beforeValidate']

Accessors

maxListeners

  • get maxListeners(): number
  • set maxListeners(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

Methods

createRecord

emit

  • emit(namespace: string, ...data: any[]): Promise<void>

  • Parameters

    • namespace: string
    • Rest ...data: any[]

    Returns Promise<void>

find

findAll

get

  • get(id: string): Promise<Record>
  • get(id: string): Promise<Record>

  • Parameters

    • id: string

    Returns Promise<Record>

  • Parameters

    • id: string

    Returns Promise<Record>

getAll

  • getAll(ids: string[]): Promise<any[]>
  • getAll(ids: string[]): Promise<any[]>

  • Parameters

    • ids: string[]

    Returns Promise<any[]>

  • Parameters

    • ids: string[]

    Returns Promise<any[]>

insert

insertAll

load

  • load(): Promise<this>
  • load(): Promise<this>

  • Returns Promise<this>

  • Returns Promise<this>

on

  • on(namespace: string | RegExp, callback: Function, once?: boolean): any

  • Parameters

    • namespace: string | RegExp
    • callback: Function
    • Default value once: boolean = false

    Returns any

once

  • once(namespace: string | RegExp, callback: Function): EventListener

  • Subscribe a callable function to a namespace, for exactly one execution.

    Parameters

    • namespace: string | RegExp
    • callback: Function

    Returns EventListener

    Used to manage the subscription status via open and close methods.

pop

  • pop(listener: EventListener): boolean

  • Remove a Listener instance from the EventNamespace instance. Called with unsubscribe method.

    Parameters

    • listener: EventListener

    Returns boolean

    A true value indicates a successful pop.

push

  • push(listener: EventListener): void

  • Add a Listener instance to the EventNamespace instance. Called with subscribe method.

    Parameters

    • listener: EventListener

    Returns void

remove

replace

  • replace(id: string, data: RecordData, validate?: boolean, rev?: string): Promise<Record>
  • replace(id: string, data: RecordData, validate?: boolean, rev?: string): Promise<Record>

  • Parameters

    • id: string
    • data: RecordData
    • Default value validate: boolean = true
    • Default value rev: string = null

    Returns Promise<Record>

  • Parameters

    • id: string
    • data: RecordData
    • Optional validate: boolean
    • Optional rev: string

    Returns Promise<Record>

save

  • save(record: Record, validate?: boolean, force?: boolean): Promise<Record>
  • save(record: Record, validate?: boolean, force?: boolean): Promise<Record>

  • Parameters

    • record: Record
    • Default value validate: boolean = true
    • Default value force: boolean = false

    Returns Promise<Record>

  • Parameters

    • record: Record
    • Optional validate: boolean
    • Optional force: boolean

    Returns Promise<Record>

truncate

  • truncate(): Promise<boolean>
  • truncate(): Promise<boolean>

  • Returns Promise<boolean>

  • Returns Promise<boolean>

update