Class PrinterService

Represents the Printer Service interface. Extends the IAppRemoteService interface with IPrinter.

Hierarchy

AppRemoteService<IPrinter>
- PrinterService

Implements

IPrinterService

Constructors

constructor

new PrinterService(http, db, options, moduleName?, methodName?): PrinterService
Parameters
- http: AxiosInstance
- db: Dexie
- options: IServiceOptions
- moduleName: string = 'printers'
- methodName: string = 'printer'
Returns PrinterService
Overrides AppRemoteService.constructor
- Defined in src/services/printer.service.ts:54

Properties

`Readonly` db

db: Dexie

`Readonly` http

http: AxiosInstance

`Readonly` methodName

methodName: string = 'printer'

`Readonly` moduleName

moduleName: string = 'printers'

`Readonly` options

options: IServiceOptions

Methods

addOne

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

deleteOne

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

getAll

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

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

getDefaultCheckPrinter

getDefaultCheckPrinter(): Promise<IPrinter>
Returns Promise<IPrinter>
- Defined in src/services/printer.service.ts:83

getDefaultKitchenPrinter

getDefaultKitchenPrinter(): Promise<IPrinter>
Returns Promise<IPrinter>
- Defined in src/services/printer.service.ts:87

getDefaultOne

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

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

getDefaultOrderPrinter

getDefaultOrderPrinter(): Promise<IPrinter>
Returns Promise<IPrinter>
- Defined in src/services/printer.service.ts:91

getDefaultReceiptPrinter

getDefaultReceiptPrinter(): Promise<IPrinter>
Retrieves the default receipt printer.

Returns Promise<IPrinter>
A promise that resolves to an IPrinter object.
Implementation of IPrinterService.getDefaultReceiptPrinter
- Defined in src/services/printer.service.ts:80

getMany

getMany(params?, options?): Promise<IGetManyResult<IPrinter>>
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<IPrinter>>
An object containing the retrieved entities and total count.
Implementation of IPrinterService.getMany
Inherited from AppRemoteService.getMany
- Defined in src/services/abstract.service.ts:164

getOne

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

getOneByParams

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

getPhysicalPrintersFromNode

getPhysicalPrintersFromNode(): Promise<INodePrinter[]>
Retrieves the physical printers from the node.

Returns Promise<INodePrinter[]>
A promise that resolves to an array of INodePrinter objects.
Implementation of IPrinterService.getPhysicalPrintersFromNode
- Defined in src/services/printer.service.ts:67

getPrintersByUids

getPrintersByUids(uids): Promise<IPrinter[]>
Parameters
- uids: string[]
Returns Promise<IPrinter[]>
- Defined in src/services/printer.service.ts:95

getUnpairedNode

getUnpairedNode(): Promise<CustomResponse<IDevice>>
Retrieves the unpaired node.

Returns Promise<CustomResponse<IDevice>>
A promise that resolves to an array of INode objects.
Implementation of IPrinterService.getUnpairedNode
- Defined in src/services/printer.service.ts:72

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 IPrinterService.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 IPrinterService.liveQuery
Inherited from AppRemoteService.liveQuery
- Defined in src/services/abstract.service.ts:107

pairNode

pairNode(nodeUid): Promise<CustomResponse<IDevice>>
Pairs the node.
Parameters
- nodeUid: string
  The node UID.
Returns Promise<CustomResponse<IDevice>>
A promise that resolves to an array of INode objects.
Implementation of IPrinterService.pairNode
- Defined in src/services/printer.service.ts:76

saveMany

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

saveOne

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

searchPrinters

searchPrinters(refresh?, port?): Promise<string[]>
Searches for available printers on the network with the specified IP address and port number.
Parameters
- refresh: boolean = false
  A boolean value indicating whether to refresh the cache. Default is false.
- port: number = 9100
  The port number of the network. Default is 9100.
Returns Promise<string[]>
A promise that resolves to an array of printer names found on the network.
Implementation of IPrinterService.searchPrinters
- Defined in src/services/printer.service.ts:100

updateMany

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

updateOne

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

Class PrinterService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

http: AxiosInstance

db: Dexie

options: IServiceOptions

moduleName: string = 'printers'

methodName: string = 'printer'

Returns PrinterService

Properties

Readonly db

Readonly http

Readonly methodName

Readonly moduleName

Readonly options

Methods

addOne

Parameters

item: IPrinter

Returns Promise<IPrinter>

deleteOne

Parameters

model: IPrinter

Returns Promise<IPrinter>

getAll

Returns Promise<IPrinter[]>

getDefaultCheckPrinter

Returns Promise<IPrinter>

getDefaultKitchenPrinter

Returns Promise<IPrinter>

getDefaultOne

Returns Promise<IPrinter>

getDefaultOrderPrinter

Returns Promise<IPrinter>

getDefaultReceiptPrinter

Returns Promise<IPrinter>

getMany

Parameters

params: any = {}

options: any = {}

Returns Promise<IGetManyResult<IPrinter>>

getOne

Parameters

uid: string

Returns Promise<IPrinter>

getOneByParams

Parameters

params: Partial<IPrinter>

Returns Promise<IPrinter>

getPhysicalPrintersFromNode

Returns Promise<INodePrinter[]>

getPrintersByUids

Parameters

uids: string[]

Returns Promise<IPrinter[]>

getUnpairedNode

Returns Promise<CustomResponse<IDevice>>

hasAny

Returns Promise<boolean>

liveQuery

Type Parameters

T

Parameters

expr: (() => T)

Returns T

Returns Observable<T>

pairNode

Parameters

nodeUid: string

Returns Promise<CustomResponse<IDevice>>

saveMany

Parameters

items: IPrinter[]

`Readonly` db

`Readonly` http

`Readonly` methodName

`Readonly` moduleName

`Readonly` options