Class Adapter

Adapter.

Hierarchy

  • Service
    • Adapter

Constructors

constructor

Properties

container

Accessors

settings

Methods

addService count create delete deleteById exists find findById getService hasService patch patchById replaceById replaceOrCreate useService

Constructors

constructor

  • new Adapter(container?, settings?): Adapter

  • Constructor.

    Parameters

    • Optional container: ServiceContainer
    • Optional settings: AnyObject

    Returns Adapter

Properties

container

container: ServiceContainer

Container.

Accessors

settings

  • get settings(): undefined | AnyObject

  • Settings.

    Returns undefined | AnyObject

Methods

addService

  • addService<T>(ctor, ...args): this

  • Add service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns this

count

  • count(modelName, where?): Promise<number>

  • Count.

    Parameters

    Returns Promise<number>

create

delete

  • delete(modelName, where?): Promise<number>

  • Delete.

    Parameters

    Returns Promise<number>

deleteById

  • deleteById(modelName, id): Promise<boolean>

  • Delete by id.

    Parameters

    • modelName: string
    • id: unknown

    Returns Promise<boolean>

exists

  • exists(modelName, id): Promise<boolean>

  • Exists.

    Parameters

    • modelName: string
    • id: unknown

    Returns Promise<boolean>

find

  • find(modelName, filter?): Promise<ModelData[]>

  • Find.

    Parameters

    Returns Promise<ModelData[]>

findById

  • findById(modelName, id, filter?): Promise<ModelData>

  • Find by id.

    Parameters

    Returns Promise<ModelData>

getService

  • getService<T>(ctor, ...args): T

  • Get service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns T

hasService

  • hasService<T>(ctor): boolean

  • Has service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>

    Returns boolean

patch

  • patch(modelName, modelData, where?): Promise<number>

  • Patch.

    Parameters

    Returns Promise<number>

patchById

  • patchById(modelName, id, modelData, filter?): Promise<ModelData>

  • Patch by id.

    Parameters

    Returns Promise<ModelData>

replaceById

  • replaceById(modelName, id, modelData, filter?): Promise<ModelData>

  • Replace by id.

    Parameters

    Returns Promise<ModelData>

replaceOrCreate

  • replaceOrCreate(modelName, modelData, filter?): Promise<ModelData>

  • Replace or create.

    Parameters

    Returns Promise<ModelData>

useService

  • useService<T>(ctor, ...args): this

  • Use service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns this

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc