1.0.2 • Published 2 years ago

rch-driver-js-core v1.0.2

Weekly downloads
-
License
MIT
Repository
bitbucket
Last release
2 years ago

API Reference

Core

Kind: global class

new Core(isSerial)

ParamTypeDefault
isSerialBooleantrue

core.header()

Kind: instance method of Core

core.footer()

Kind: instance method of Core

core.cmd(protocolCommand)

Kind: instance method of Core

ParamType
protocolCommandString

core.parseBool(value) ⇒ number

Kind: instance method of Core
Date: 1/11/2022 - 2:18:03 AM

ParamType
valueboolean

core.subtotal()

Kind: instance method of Core

core.clear()

Kind: instance method of Core

core.cancel()

Kind: instance method of Core

core.transfer()

Kind: instance method of Core

core.paperPeekOut()

Kind: instance method of Core

core.departmentSell(departmentId, description, value, qty, sellType) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:51:45 AM

ParamTypeDefault
departmentIdnumber
descriptionstring
valuenumber
qtynumber1
sellTypeSellType

core.departmentSellFromLineItem(lineItem)

Kind: instance method of Core

ParamType
lineItemLineItemDTO

core.returnGoods(date, closure, number, onlyCheck) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:52:14 AM

ParamType
dateDate
closurenumber
numbernumber
onlyCheckboolean

core.returnGoodsFromDTO(returnInfo) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:52:45 AM

ParamType
returnInfoReturnInfoDTO

core.lottery(code)

Kind: instance method of Core

ParamType
codeString

core.discountPercentage(percentage, description)

Kind: instance method of Core

ParamType
percentageNumber
descriptionString

core.increasePercentage(percentage, description)

Kind: instance method of Core

ParamType
percentageNumber
descriptionString

core.discountValue(value, description)

Kind: instance method of Core

ParamType
valueNumber
descriptionString

core.increaseValue(value, description)

Kind: instance method of Core

ParamType
valueNumber
descriptionString

core.increaseValueSubtotal(value, description)

Kind: instance method of Core

ParamType
valueNumber
descriptionString

core.openNonFiscalReceipt(cutPaper, heading)

Kind: instance method of Core

ParamType
cutPaperBoolean
headingBoolean ⎮ null

core.closeNonFiscalReceipt()

Kind: instance method of Core

core.payment(paymentId, value, description)

Kind: instance method of Core

ParamType
paymentIdNumber
valueNumber
descriptionString ⎮ null

core.paymentFromPaymentItem(paymentItem) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:54:00 AM

ParamType
paymentItemPaymentItemDTO

core.returnReceipt(date, closure, number, onlyCheck, serialNumber)

Kind: instance method of Core

ParamType
dateString
closureNumber
numberNumber
onlyCheck
serialNumber

core.returnReceiptFromDTO(returnInfo)

Kind: instance method of Core

ParamType
returnInfoReturnInfoDTO

core.getLastReceipt()

Kind: instance method of Core

core.giftReceipt()

Kind: instance method of Core

core.operator(operatorId)

Kind: instance method of Core

ParamType
operatorIdNumber

core.closeReceipt()

Kind: instance method of Core

core.terminateOperation()

Kind: instance method of Core

core.printRow(content)

Kind: instance method of Core

ParamType
contentString ⎮ RowDTO

core.printRowAfterTotal(content)

Kind: instance method of Core

ParamType
contentString

core.printRowBeforeFiscalContent(content)

Kind: instance method of Core

ParamType
contentString

core.printFiscalCode(fiscalCode)

Kind: instance method of Core

ParamType
fiscalCodeString

core.reg()

Kind: instance method of Core

core.x()

Kind: instance method of Core

core.z()

Kind: instance method of Core

core.prg()

Kind: instance method of Core

core.srv()

Kind: instance method of Core

core.xReport()

Kind: instance method of Core

core.zReport()

Kind: instance method of Core

core.restart()

Kind: instance method of Core

core.updateOnDemand()

Kind: instance method of Core

core.sendPendingXmls()

Kind: instance method of Core

core.testXmlUrl()

Kind: instance method of Core

core.displayMessage(rowId, message)

Kind: instance method of Core

ParamType
rowIdNumber
messageString

core.printBarCode(type, code)

Kind: instance method of Core

ParamType
typeNumber
codeString

core.printBarCode_UpcE(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Ean13(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Ean8(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Code39(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_UpcA(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Itf(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Codabar(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Code128(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Code93(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_QRCode(code)

Kind: instance method of Core

ParamType
codeString

core.dgfeStatus()

Kind: instance method of Core

core.periodicAssessmentStatus()

Kind: instance method of Core

core.inactivityAndPendings()

Kind: instance method of Core

core.dgfeFreeSpace()

Kind: instance method of Core

core.deviceStatus()

Kind: instance method of Core

core.printerStatus()

Kind: instance method of Core

core.getSerialNumber()

Kind: instance method of Core

core.getFirmwareRevision()

Kind: instance method of Core

core.rtStatus()

Kind: instance method of Core

core.pendingXmlStatus()

Kind: instance method of Core

core.inServiceStatus()

Kind: instance method of Core

core.allProgramming()

Kind: instance method of Core

core.C125(vat_on_ticket)

Kind: instance method of Core

ParamType
vat_on_ticketBoolean

core.C126(midnight_alert)

Kind: instance method of Core

ParamType
midnight_alertBoolean

core.C132(print_register_number)

Kind: instance method of Core

ParamType
print_register_numberBoolean

core.C133(subtotal_required)

Kind: instance method of Core

ParamType
subtotal_requiredBoolean

core.C135(max_receipt_amount)

Kind: instance method of Core

ParamType
max_receipt_amountNumber

core.C136(change_on_payments)

Kind: instance method of Core

ParamType
change_on_paymentsBoolean

core.C138(department_net)

Kind: instance method of Core

ParamType
department_netBoolean

core.C170(rt_print_appendix, rt_enable_appendix_Cut)

Kind: instance method of Core

ParamType
rt_print_appendixBoolean
rt_enable_appendix_CutBoolean

core.C451(date)

Kind: instance method of Core

ParamType
dateString

core.C452(date)

Kind: instance method of Core

ParamType
dateString

core.C917(invoice_on_receipt_enable, receipt_print_on_2_lines, invoice_subtotal_enable, invoice_disable_check_client, invoice_print_unit_price)

Kind: instance method of Core

ParamType
invoice_on_receipt_enableBoolean
receipt_print_on_2_linesBoolean
invoice_subtotal_enableBoolean
invoice_disable_check_clientBoolean
invoice_print_unit_priceBoolean

core.C918(id, name)

Kind: instance method of Core

ParamType
idNumber
nameString

core.C927(print_unit_price, print_single_quantity)

Kind: instance method of Core

ParamType
print_unit_priceBoolean
print_single_quantityBoolean

core.C928(disable_double_feed)

Kind: instance method of Core

ParamType
disable_double_feedBoolean

core.C932(print_with_buffering)

Kind: instance method of Core

ParamType
print_with_bufferingBoolean

core.C980(notify_cash)

Kind: instance method of Core

ParamType
notify_cashBoolean

core.C997(enabled_cutter)

Kind: instance method of Core

ParamType
enabled_cutterBoolean

core.H(headingRow, description)

Kind: instance method of Core

ParamType
headingRowNumber
descriptionString

core.t(courtesyRow, description)

Kind: instance method of Core

ParamType
courtesyRowNumber
descriptionString

core.O(operatorId, name)

Kind: instance method of Core

ParamType
operatorIdNumber
nameString

core.R(deptId, price, vat, name, halo, lalo, single, grp_code, dpt_type)

Kind: instance method of Core

ParamType
deptIdNumber
priceNumber
vatNumber
nameString
haloNumber
laloNumber
singleBoolean
grp_codeNumber ⎮ null
dpt_typeString

core.T(paymentId, name, change, cash, pay_discount, tender_credit_type, opendrawer, input_total_amount, ticket)

Kind: instance method of Core

ParamType
paymentIdNumber
nameString
changeBoolean
cashBoolean
pay_discountBoolean
tender_credit_typeString
opendrawerBoolean
input_total_amountBoolean
ticketBoolean

core.U(department_discount)

Kind: instance method of Core

ParamType
department_discountBoolean

core.V(vatId, rate_type, value, ateco_code)

Kind: instance method of Core

ParamType
vatIdNumber
rate_typeString
valueNumber
ateco_codeString

core.dptTypeStringToInt(val)

Kind: instance method of Core

ParamType
valString

core.dptIntToTypeString(val)

Kind: instance method of Core

ParamType
valNumber

core.rateStringToInt(value)

Kind: instance method of Core

ParamType
valueString

core.natureStringToInt(value)

Kind: instance method of Core

ParamType
valueString

core.creditStringToInt(tender_credit_type)

Kind: instance method of Core

ParamType
tender_credit_typeString

core.creditIntToString(tender_credit_type)

Kind: instance method of Core

ParamType
tender_credit_typeNumber

BarCodeType : enum

Kind: global enum
Date: 1/11/2022 - 10:07:11 AM

BillType : enum

Kind: global enum
Date: 1/11/2022 - 10:11:25 AM

SellType : enum

Kind: global enum
Date: 1/11/2022 - 10:52:47 AM
See: LineItemDTO

Core : Core

Kind: global typedef
Date: 1/11/2022 - 1:59:01 AM

new Core(isSerial)

ParamTypeDefault
isSerialBooleantrue

core.header()

Kind: instance method of Core

core.footer()

Kind: instance method of Core

core.cmd(protocolCommand)

Kind: instance method of Core

ParamType
protocolCommandString

core.parseBool(value) ⇒ number

Kind: instance method of Core
Date: 1/11/2022 - 2:18:03 AM

ParamType
valueboolean

core.subtotal()

Kind: instance method of Core

core.clear()

Kind: instance method of Core

core.cancel()

Kind: instance method of Core

core.transfer()

Kind: instance method of Core

core.paperPeekOut()

Kind: instance method of Core

core.departmentSell(departmentId, description, value, qty, sellType) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:51:45 AM

ParamTypeDefault
departmentIdnumber
descriptionstring
valuenumber
qtynumber1
sellTypeSellType

core.departmentSellFromLineItem(lineItem)

Kind: instance method of Core

ParamType
lineItemLineItemDTO

core.returnGoods(date, closure, number, onlyCheck) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:52:14 AM

ParamType
dateDate
closurenumber
numbernumber
onlyCheckboolean

core.returnGoodsFromDTO(returnInfo) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:52:45 AM

ParamType
returnInfoReturnInfoDTO

core.lottery(code)

Kind: instance method of Core

ParamType
codeString

core.discountPercentage(percentage, description)

Kind: instance method of Core

ParamType
percentageNumber
descriptionString

core.increasePercentage(percentage, description)

Kind: instance method of Core

ParamType
percentageNumber
descriptionString

core.discountValue(value, description)

Kind: instance method of Core

ParamType
valueNumber
descriptionString

core.increaseValue(value, description)

Kind: instance method of Core

ParamType
valueNumber
descriptionString

core.increaseValueSubtotal(value, description)

Kind: instance method of Core

ParamType
valueNumber
descriptionString

core.openNonFiscalReceipt(cutPaper, heading)

Kind: instance method of Core

ParamType
cutPaperBoolean
headingBoolean ⎮ null

core.closeNonFiscalReceipt()

Kind: instance method of Core

core.payment(paymentId, value, description)

Kind: instance method of Core

ParamType
paymentIdNumber
valueNumber
descriptionString ⎮ null

core.paymentFromPaymentItem(paymentItem) ⇒ string

Kind: instance method of Core
Date: 1/11/2022 - 1:54:00 AM

ParamType
paymentItemPaymentItemDTO

core.returnReceipt(date, closure, number, onlyCheck, serialNumber)

Kind: instance method of Core

ParamType
dateString
closureNumber
numberNumber
onlyCheck
serialNumber

core.returnReceiptFromDTO(returnInfo)

Kind: instance method of Core

ParamType
returnInfoReturnInfoDTO

core.getLastReceipt()

Kind: instance method of Core

core.giftReceipt()

Kind: instance method of Core

core.operator(operatorId)

Kind: instance method of Core

ParamType
operatorIdNumber

core.closeReceipt()

Kind: instance method of Core

core.terminateOperation()

Kind: instance method of Core

core.printRow(content)

Kind: instance method of Core

ParamType
contentString ⎮ RowDTO

core.printRowAfterTotal(content)

Kind: instance method of Core

ParamType
contentString

core.printRowBeforeFiscalContent(content)

Kind: instance method of Core

ParamType
contentString

core.printFiscalCode(fiscalCode)

Kind: instance method of Core

ParamType
fiscalCodeString

core.reg()

Kind: instance method of Core

core.x()

Kind: instance method of Core

core.z()

Kind: instance method of Core

core.prg()

Kind: instance method of Core

core.srv()

Kind: instance method of Core

core.xReport()

Kind: instance method of Core

core.zReport()

Kind: instance method of Core

core.restart()

Kind: instance method of Core

core.updateOnDemand()

Kind: instance method of Core

core.sendPendingXmls()

Kind: instance method of Core

core.testXmlUrl()

Kind: instance method of Core

core.displayMessage(rowId, message)

Kind: instance method of Core

ParamType
rowIdNumber
messageString

core.printBarCode(type, code)

Kind: instance method of Core

ParamType
typeNumber
codeString

core.printBarCode_UpcE(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Ean13(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Ean8(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Code39(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_UpcA(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Itf(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Codabar(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Code128(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_Code93(code)

Kind: instance method of Core

ParamType
codeString

core.printBarCode_QRCode(code)

Kind: instance method of Core

ParamType
codeString

core.dgfeStatus()

Kind: instance method of Core

core.periodicAssessmentStatus()

Kind: instance method of Core

core.inactivityAndPendings()

Kind: instance method of Core

core.dgfeFreeSpace()

Kind: instance method of Core

core.deviceStatus()

Kind: instance method of Core

core.printerStatus()

Kind: instance method of Core

core.getSerialNumber()

Kind: instance method of Core

core.getFirmwareRevision()

Kind: instance method of Core

core.rtStatus()

Kind: instance method of Core

core.pendingXmlStatus()

Kind: instance method of Core

core.inServiceStatus()

Kind: instance method of Core

core.allProgramming()

Kind: instance method of Core

core.C125(vat_on_ticket)

Kind: instance method of Core

ParamType
vat_on_ticketBoolean

core.C126(midnight_alert)

Kind: instance method of Core

ParamType
midnight_alertBoolean

core.C132(print_register_number)

Kind: instance method of Core

ParamType
print_register_numberBoolean

core.C133(subtotal_required)

Kind: instance method of Core

ParamType
subtotal_requiredBoolean

core.C135(max_receipt_amount)

Kind: instance method of Core

ParamType
max_receipt_amountNumber

core.C136(change_on_payments)

Kind: instance method of Core

ParamType
change_on_paymentsBoolean

core.C138(department_net)

Kind: instance method of Core

ParamType
department_netBoolean

core.C170(rt_print_appendix, rt_enable_appendix_Cut)

Kind: instance method of Core

ParamType
rt_print_appendixBoolean
rt_enable_appendix_CutBoolean

core.C451(date)

Kind: instance method of Core

ParamType
dateString

core.C452(date)

Kind: instance method of Core

ParamType
dateString

core.C917(invoice_on_receipt_enable, receipt_print_on_2_lines, invoice_subtotal_enable, invoice_disable_check_client, invoice_print_unit_price)

Kind: instance method of Core

ParamType
invoice_on_receipt_enableBoolean
receipt_print_on_2_linesBoolean
invoice_subtotal_enableBoolean
invoice_disable_check_clientBoolean
invoice_print_unit_priceBoolean

core.C918(id, name)

Kind: instance method of Core

ParamType
idNumber
nameString

core.C927(print_unit_price, print_single_quantity)

Kind: instance method of Core

ParamType
print_unit_priceBoolean
print_single_quantityBoolean

core.C928(disable_double_feed)

Kind: instance method of Core

ParamType
disable_double_feedBoolean

core.C932(print_with_buffering)

Kind: instance method of Core

ParamType
print_with_bufferingBoolean

core.C980(notify_cash)

Kind: instance method of Core

ParamType
notify_cashBoolean

core.C997(enabled_cutter)

Kind: instance method of Core

ParamType
enabled_cutterBoolean

core.H(headingRow, description)

Kind: instance method of Core

ParamType
headingRowNumber
descriptionString

core.t(courtesyRow, description)

Kind: instance method of Core

ParamType
courtesyRowNumber
descriptionString

core.O(operatorId, name)

Kind: instance method of Core

ParamType
operatorIdNumber
nameString

core.R(deptId, price, vat, name, halo, lalo, single, grp_code, dpt_type)

Kind: instance method of Core

ParamType
deptIdNumber
priceNumber
vatNumber
nameString
haloNumber
laloNumber
singleBoolean
grp_codeNumber ⎮ null
dpt_typeString

core.T(paymentId, name, change, cash, pay_discount, tender_credit_type, opendrawer, input_total_amount, ticket)

Kind: instance method of Core

ParamType
paymentIdNumber
nameString
changeBoolean
cashBoolean
pay_discountBoolean
tender_credit_typeString
opendrawerBoolean
input_total_amountBoolean
ticketBoolean

core.U(department_discount)

Kind: instance method of Core

ParamType
department_discountBoolean

core.V(vatId, rate_type, value, ateco_code)

Kind: instance method of Core

ParamType
vatIdNumber
rate_typeString
valueNumber
ateco_codeString

core.dptTypeStringToInt(val)

Kind: instance method of Core

ParamType
valString

core.dptIntToTypeString(val)

Kind: instance method of Core

ParamType
valNumber

core.rateStringToInt(value)

Kind: instance method of Core

ParamType
valueString

core.natureStringToInt(value)

Kind: instance method of Core

ParamType
valueString

core.creditStringToInt(tender_credit_type)

Kind: instance method of Core

ParamType
tender_credit_typeString

core.creditIntToString(tender_credit_type)

Kind: instance method of Core

ParamType
tender_credit_typeNumber

BillDTO : BillDTO

Kind: global typedef
Date: 1/11/2022 - 10:10:12 AM

billDTO.isReturn : boolean

Kind: instance property of BillDTO
Read only: true
Date: 1/11/2022 - 10:12:52 AM

billDTO.isCancel : boolean

Kind: instance property of BillDTO
Read only: true
Date: 1/11/2022 - 10:14:08 AM

billDTO.isReceipt : boolean

Kind: instance property of BillDTO
Read only: true
Date: 1/11/2022 - 10:14:45 AM

DiscountDTO : DiscountDTO

Kind: global typedef
Date: 1/11/2022 - 10:17:38 AM
See: BillItemDTO

LineItemDTO : LineItemDTO

Kind: global typedef
Date: 1/11/2022 - 10:19:19 AM
See: BillDTO

PaymentItemDTO : PaymentItemDTO

Kind: global typedef
Date: 1/11/2022 - 10:29:11 AM
See: BillDTO

ReturnInfoDTO : ReturnInfoDTO

Kind: global typedef
Date: 1/11/2022 - 10:33:57 AM
See: BillDTO

RowDTO : RowDTO

Kind: global typedef
Date: 1/11/2022 - 10:37:05 AM

RowDTO.fromString(value) ⇒ RowDTO

Kind: static method of RowDTO
Date: 1/11/2022 - 10:47:39 AM

ParamType
valuestring

Example

const simpleRow = 'yoursimplerow';
const rowDoubleSize = 'yourtextgoeshere||1'; // Double size
const barCode = 'thecode|11 //barcode types between 1 to 11

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago