Class ItemService

Interface for a generic service.

Hierarchy

AppRemoteService<IItem>
- ItemService

Implements

IItemService

Constructors

constructor

new ItemService(http, db, options, moduleName?, methodName?): ItemService
Parameters
- http: AxiosInstance
- db: Dexie
- options: IServiceOptions
- moduleName: string = 'items'
- methodName: string = 'item'
Returns ItemService
Overrides AppRemoteService.constructor
- Defined in src/services/app.service.ts:230

Properties

`Readonly` db

db: Dexie

`Readonly` http

http: AxiosInstance

`Readonly` methodName

methodName: string = 'item'

`Readonly` moduleName

moduleName: string = 'items'

`Readonly` options

options: IServiceOptions

Methods

addImageAsync

addImageAsync(file, item): Promise<IItem>
Adds an image to an item.
Parameters
- file: File
  The image file to add.
- item: IItem
  The item to add the image to.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.addImageAsync
- Defined in src/services/app.service.ts:309

addModifier

addModifier(item, modifier): Promise<IItem>
Adds a modifier to an item.
Parameters
- item: IItem
  The item to add the modifier to.
- modifier: ICoreItem
  The modifier to add.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.addModifier
- Defined in src/services/app.service.ts:273

addModifierCategory

addModifierCategory(item, category): Promise<IItem>
Adds a modifier category to an item.
Parameters
- item: IItem
  The item to add the modifier category to.
- category: ICoreCategory
  The category to add.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.addModifierCategory
- Defined in src/services/app.service.ts:249

addOne

addOne(item): Promise<IItem>
Parameters
- item: IItem
Returns Promise<IItem>
Implementation of IItemService.addOne
Inherited from AppRemoteService.addOne
- Defined in src/services/abstract.service.ts:218

attachModifierToGroup

attachModifierToGroup(item, modifier_uid, category_uid): Promise<IItem>
attach a ungrouped modifier to a modifier group (category) if you want to detach a modifier from a group, pass an empty string as the category_uid
Parameters
- item: IItem
  the item to attach the modifier to it's modifier category
- modifier_uid: string
  the uid of the modifier to attach
- category_uid: string
  the uid of the category to attach the modifier to
Returns Promise<IItem>
Implementation of IItemService.attachModifierToGroup
- Defined in src/services/app.service.ts:297

changeStock

changeStock(uid, stock): Promise<IItem>
change the stock of an item by increment or decrement
Parameters
- uid: string
  uid of the item to change stock
- stock: number
  the quantity to change the stock by, can be negative
Returns Promise<IItem>
Implementation of IItemService.changeStock
- Defined in src/services/app.service.ts:330

changeToSoldOut

changeToSoldOut(uid): Promise<IItem>
mark an item as sold out
Parameters
- uid: string
  uid of the item to change to sold out
Returns Promise<IItem>
Implementation of IItemService.changeToSoldOut
- Defined in src/services/app.service.ts:324

deleteOne

deleteOne(model): Promise<IItem>
Parameters
- model: IItem
Returns Promise<IItem>
Implementation of IItemService.deleteOne
Inherited from AppRemoteService.deleteOne
- Defined in src/services/abstract.service.ts:227

getAll

getAll(): Promise<IItem[]>
Retrieves all entities with optional pagination.

Returns Promise<IItem[]>
A Promise that resolves to an array of retrieved entities.
Implementation of IItemService.getAll
Inherited from AppRemoteService.getAll
- Defined in src/services/abstract.service.ts:160

getDefaultOne

getDefaultOne(): Promise<IItem>
Retrieves a single entity by its unique identifier.

Returns Promise<IItem>
A Promise that resolves to the retrieved entity or undefined.
Implementation of IItemService.getDefaultOne
Inherited from AppRemoteService.getDefaultOne
- Defined in src/services/abstract.service.ts:152

getMany

getMany(params?, options?): Promise<IGetManyResult<IItem>>
Retrieves multiple entities with optional pagination and filtering.
Parameters
- params: any = {}
  [UNUSED PARAMETER, KEPT FOR POSSIBLE FUTURE USE] Filtering parameters.
- options: any = {}
  Query options including pagination.
Returns Promise<IGetManyResult<IItem>>
An object containing the retrieved entities and total count.
Implementation of IItemService.getMany
Inherited from AppRemoteService.getMany
- Defined in src/services/abstract.service.ts:164

getOne

getOne(uid): Promise<IItem>
get one by uid
Parameters
- uid: string
  Primary nano id
Returns Promise<IItem>
Implementation of IItemService.getOne
Inherited from AppRemoteService.getOne
- Defined in src/services/abstract.service.ts:144

getOneByParams

getOneByParams(params): Promise<IItem>
Retrieves a single entity by its unique identifier.
Parameters
- params: Partial<IItem>
  Filtering parameters.
Returns Promise<IItem>
A Promise that resolves to the retrieved entity or undefined.
Implementation of IItemService.getOneByParams
Inherited from AppRemoteService.getOneByParams
- Defined in src/services/abstract.service.ts:148

hasAny

hasAny(): Promise<boolean>
Checks if any entity exists.

Returns Promise<boolean>
A Promise that resolves to true if any entity exists or false otherwise.
Implementation of IItemService.hasAny
Inherited from AppRemoteService.hasAny
- Defined in src/services/abstract.service.ts:135

liveQuery

liveQuery<T>(expr): Observable<T>
Creates a live query.
Type Parameters
- T
Parameters
- expr: (() => T)
  Function that returns the query expression.
  - - (): T
    - Returns T
Returns Observable<T>
A live query.
Implementation of IItemService.liveQuery
Inherited from AppRemoteService.liveQuery
- Defined in src/services/abstract.service.ts:107

removeModifier

removeModifier(item, modifier): Promise<IItem>
Removes a modifier from an item.
Parameters
- item: IItem
  The item to remove the modifier from.
- modifier: ICoreItem
  The modifier to remove.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.removeModifier
- Defined in src/services/app.service.ts:289

removeModifierCategory

removeModifierCategory(item, category): Promise<IItem>
Removes a modifier category from an item.
Parameters
- item: IItem
  The item to remove the modifier category from.
- category: ICoreCategory
  The category to remove.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.removeModifierCategory
- Defined in src/services/app.service.ts:265

saveMany

saveMany(items): Promise<IItem[]>
Saves multiple entities.
Parameters
- items: IItem[]
  Entities to save.
Returns Promise<IItem[]>
A Promise that resolves to the saved entities.
Implementation of IItemService.saveMany
Inherited from AppRemoteService.saveMany
- Defined in src/services/abstract.service.ts:122

saveOne

saveOne(item): Promise<IItem>
Saves a single entity.
Parameters
- item: IItem
  Entity to save.
Returns Promise<IItem>
A Promise that resolves to the saved entity.
Implementation of IItemService.saveOne
Inherited from AppRemoteService.saveOne
- Defined in src/services/abstract.service.ts:111

search

search(query): Promise<IItem[]>
Searches for items by name, codename or barcode.
Parameters
- query: string
  The search query.
Returns Promise<IItem[]>
A Promise that resolves to an array of IItem objects.
Implementation of IItemService.search
- Defined in src/services/app.service.ts:234

updateMany

updateMany(items): Promise<IItem[]>
Parameters
- items: IItem[]
Returns Promise<IItem[]>
Implementation of IItemService.updateMany
Inherited from AppRemoteService.updateMany
- Defined in src/services/abstract.service.ts:224

updateModifier

updateModifier(item, modifier): Promise<IItem>
Updates a modifier of an item.
Parameters
- item: IItem
  The item to update the modifier of.
- modifier: ICoreItem
  The modifier to update.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.updateModifier
- Defined in src/services/app.service.ts:279

updateModifierCategory

updateModifierCategory(item, category): Promise<IItem>
Updates a modifier category of an item.
Parameters
- item: IItem
  The item to update the modifier category of.
- category: ICoreCategory
  The category to update.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
Implementation of IItemService.updateModifierCategory
- Defined in src/services/app.service.ts:255

updateOne

updateOne(id, item): Promise<IItem>
Parameters
- id: number
- item: Partial<IItem>
Returns Promise<IItem>
Implementation of IItemService.updateOne
Inherited from AppRemoteService.updateOne
- Defined in src/services/abstract.service.ts:221

Class ItemService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

http: AxiosInstance

db: Dexie

options: IServiceOptions

moduleName: string = 'items'

methodName: string = 'item'

Returns ItemService

Properties

Readonly db

Readonly http

Readonly methodName

Readonly moduleName

Readonly options

Methods

addImageAsync

Parameters

file: File

item: IItem

Returns Promise<IItem>

addModifier

Parameters

item: IItem

modifier: ICoreItem

Returns Promise<IItem>

addModifierCategory

Parameters

item: IItem

category: ICoreCategory

Returns Promise<IItem>

addOne

Parameters

item: IItem

Returns Promise<IItem>

attachModifierToGroup

Parameters

item: IItem

modifier_uid: string

category_uid: string

Returns Promise<IItem>

changeStock

Parameters

uid: string

stock: number

Returns Promise<IItem>

changeToSoldOut

Parameters

uid: string

Returns Promise<IItem>

deleteOne

Parameters

model: IItem

Returns Promise<IItem>

getAll

Returns Promise<IItem[]>

getDefaultOne

Returns Promise<IItem>

getMany

Parameters

params: any = {}

options: any = {}

Returns Promise<IGetManyResult<IItem>>

getOne

Parameters

uid: string

Returns Promise<IItem>

getOneByParams

Parameters

params: Partial<IItem>

Returns Promise<IItem>

hasAny

Returns Promise<boolean>

`Readonly` db

`Readonly` http

`Readonly` methodName

`Readonly` moduleName

`Readonly` options