Interface IItemService

Interface for a generic service.

Hierarchy

IAppRemoteService<IItem>
- IItemService

Implemented by

ItemService

Properties

db

db: Dexie

moduleName

moduleName: string

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.
- Defined in src/services/app.service.ts:155

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.
- Defined in src/services/app.service.ts:185

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: ICategory
  The category to add.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
- Defined in src/services/app.service.ts:163

addOne

addOne(item): Promise<IItem>
Parameters
- item: IItem
Returns Promise<IItem>
Inherited from IAppRemoteService.addOne
- Defined in src/services/abstract.service.ts:205

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>
- Defined in src/services/app.service.ts:207

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>
- Defined in src/services/app.service.ts:227

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>
- Defined in src/services/app.service.ts:220

deleteOne

deleteOne(model): Promise<IItem>
Parameters
- model: IItem
Returns Promise<IItem>
Inherited from IAppRemoteService.deleteOne
- Defined in src/services/abstract.service.ts:208

getAll

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

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

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.
Inherited from IAppRemoteService.getDefaultOne
- Defined in src/services/abstract.service.ts:69

getMany

getMany(params, options): Promise<{
    count: number;
    list: IItem[];
    page: number;
    pageSize: number;
}>
Retrieves multiple entities with optional pagination and filtering.
Parameters
- params: any
  [UNUSED PARAMETER, KEPT FOR POSSIBLE FUTURE USE] Filtering parameters.
- options: {
  page?: number;
  pageSize?: number;
  }
  Query options including pagination.
  - Optional page?: number
  - Optional pageSize?: number
Returns Promise<{
    count: number;
    list: IItem[];
    page: number;
    pageSize: number;
}>
An object containing the retrieved entities and total count.
Inherited from IAppRemoteService.getMany
- Defined in src/services/abstract.service.ts:86

getOne

getOne(id): Promise<IItem>
Retrieves a single entity by its unique identifier.
Parameters
- id: string
  Unique identifier of the entity to retrieve.
Returns Promise<IItem>
A Promise that resolves to the retrieved entity or undefined.
Inherited from IAppRemoteService.getOne
- Defined in src/services/abstract.service.ts:56

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.
Inherited from IAppRemoteService.getOneByParams
- Defined in src/services/abstract.service.ts:63

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.
Inherited from IAppRemoteService.hasAny
- Defined in src/services/abstract.service.ts:50

liveQuery

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

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.
- Defined in src/services/app.service.ts:199

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: ICategory
  The category to remove.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
- Defined in src/services/app.service.ts:177

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.
Inherited from IAppRemoteService.saveMany
- Defined in src/services/abstract.service.ts:44

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.
Inherited from IAppRemoteService.saveOne
- Defined in src/services/abstract.service.ts:37

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.
- Defined in src/services/app.service.ts:214

updateMany

updateMany(items): Promise<IItem[]>
Parameters
- items: IItem[]
Returns Promise<IItem[]>
Inherited from IAppRemoteService.updateMany
- Defined in src/services/abstract.service.ts:207

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.
- Defined in src/services/app.service.ts:192

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: ICategory
  The category to update.
Returns Promise<IItem>
A Promise that resolves to the updated IItem object.
- Defined in src/services/app.service.ts:170

updateOne

updateOne(id, item): Promise<IItem>
Parameters
- id: number
- item: Partial<IItem>
Returns Promise<IItem>
Inherited from IAppRemoteService.updateOne
- Defined in src/services/abstract.service.ts:206

Interface IItemService

Hierarchy

Implemented by

Index

Properties

Methods

Properties

db

moduleName

Methods

addImageAsync

Parameters

file: File

item: IItem

Returns Promise<IItem>

addModifier

Parameters

item: IItem

modifier: ICoreItem

Returns Promise<IItem>

addModifierCategory

Parameters

item: IItem

category: ICategory

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: { page?: number; pageSize?: number; }

Optional page?: number

Optional pageSize?: number

Returns Promise<{ count: number; list: IItem[]; page: number; pageSize: number; }>

getOne

Parameters

id: string

Returns Promise<IItem>

getOneByParams

Parameters

params: Partial<IItem>

Returns Promise<IItem>

hasAny

Returns Promise<boolean>

liveQuery

Type Parameters

T

Parameters

expr: (() => T)

Returns T

Returns Observable<any>

removeModifier

Parameters

item: IItem

modifier: ICoreItem

options: {
page?: number;
pageSize?: number;
}

`Optional` page?: number

`Optional` pageSize?: number

Returns Promise<{
count: number;
list: IItem[];
page: number;
pageSize: number;
}>