Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

Implements

  • ServiceMethods<T>

Index

Constructors

constructor

Properties

events

events: string[]

id

id: string

options

Methods

allowsMulti

  • allowsMulti(method: string): boolean
  • Parameters

    • method: string

    Returns boolean

create

  • Parameters

    Returns Promise<T | T[]>

filterQuery

  • filterQuery(params?: Params, opts?: any): {} & { paginate: any }
  • Parameters

    • Optional params: Params
    • Optional opts: any

    Returns {} & { paginate: any }

find

  • find(params?: Params): Promise<T | T[] | Paginated<T>>
  • Parameters

    • Optional params: Params

    Returns Promise<T | T[] | Paginated<T>>

get

  • Parameters

    • id: Id
    • Optional params: Params

    Returns Promise<T>

patch

  • patch(id: NullableId, data: Partial<T>, params?: Params): Promise<T>
  • Parameters

    • id: NullableId
    • data: Partial<T>
    • Optional params: Params

    Returns Promise<T>

remove

  • remove(id: NullableId, params?: Params): Promise<T>
  • Parameters

    • id: NullableId
    • Optional params: Params

    Returns Promise<T>

update

  • update(id: Id, data: T, params?: Params): Promise<T>
  • Parameters

    • id: Id
    • data: T
    • Optional params: Params

    Returns Promise<T>

Generated using TypeDoc