@atlantis-of-code/aoc-client documentation
  1. Interfaces
  2. AocRestApi

File

projects/aoc-client/core/services/aoc-rest/aoc-rest-api.ts

Index

Methods

Methods

count
count(modelClass, where: AocFilterQuery, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
Returns : Promise<number>
delete
delete(modelClass, model: M)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
model M No
Returns : Promise<void>
find
find(modelClass, where: AocFilterQuery, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
Returns : Promise<M[]>
find$
find$(modelClass, where: AocFilterQuery, options?: AocRestOptions, clientOptions?: AocRestClientOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
clientOptions AocRestClientOptions Yes
Returns : Observable<M[]>
findAndCount
findAndCount(modelClass, where: AocFilterQuery, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
Returns : Promise<RestListDataResponse<M[]>>
findAndCount$
findAndCount$(modelClass, where: AocFilterQuery, options?: AocRestOptions, clientOptions?: AocRestClientOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
clientOptions AocRestClientOptions Yes
Returns : Observable<RestListDataResponse<M[]>>
findOne
findOne(modelClass, where: AocFilterQuery, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
Returns : Promise<M | null>
findOne$
findOne$(modelClass, where: AocFilterQuery, options?: AocRestOptions, clientOptions?: AocRestClientOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
options AocRestOptions Yes
clientOptions AocRestClientOptions Yes
Returns : Observable<M | null>
nativeUpdate
nativeUpdate(modelClass, where: AocFilterQuery, data: AocPartial<M>)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
where AocFilterQuery No
data AocPartial<M> No
Returns : Promise<number[]>
offset
offset(modelClass, modelOrId: M | AocModelId, where: AocFilterQuery, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
modelOrId M | AocModelId No
where AocFilterQuery No
options AocRestOptions Yes
Returns : Promise<OffsetResponse>
persist
persist(modelClass, model: M, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
model M No
options AocRestOptions Yes
Returns : Promise<M>
persistWithTask
persistWithTask(modelClass, model: M, options?: AocRestOptions)
Type parameters :
  • M
Parameters :
Name Type Optional
modelClass No
model M No
options AocRestOptions Yes
Returns : Promise<M>

results matching ""

    No results matching ""