@robinpath/qr
0.1.2Node.jsPublicQR Code module for RobinPath.
QR Code
QR Code module for RobinPath.
Package: @robinpath/qr | Category: Utility | Type: Utility
Authentication
No authentication required. All functions are available immediately.
Use Cases
Use the qr module when you need to:
- generateQrUrl -- Use
qr.generateQrUrlto perform this operation - generateQrDataUrl -- Use
qr.generateQrDataUrlto perform this operation - generateWifiQr -- Use
qr.generateWifiQrto perform this operation - generateVCardQr -- Use
qr.generateVCardQrto perform this operation - generateEmailQr -- Use
qr.generateEmailQrto perform this operation
Quick Reference
| Function | Description | Returns |
|---|---|---|
generateQrUrl | generateQrUrl | object |
generateQrDataUrl | generateQrDataUrl | object |
generateWifiQr | generateWifiQr | object |
generateVCardQr | generateVCardQr | object |
generateEmailQr | generateEmailQr | object |
generateSmsQr | generateSmsQr | object |
generateUrlQr | generateUrlQr | object |
generateTextQr | generateTextQr | object |
Functions
generateQrUrl
generateQrUrl
Module: qr | Returns: object -- API response.
qr.generateQrUrl
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateQrDataUrl
generateQrDataUrl
Module: qr | Returns: object -- API response.
qr.generateQrDataUrl
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateWifiQr
generateWifiQr
Module: qr | Returns: object -- API response.
qr.generateWifiQr
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateVCardQr
generateVCardQr
Module: qr | Returns: object -- API response.
qr.generateVCardQr
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateEmailQr
generateEmailQr
Module: qr | Returns: object -- API response.
qr.generateEmailQr
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateSmsQr
generateSmsQr
Module: qr | Returns: object -- API response.
qr.generateSmsQr
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateUrlQr
generateUrlQr
Module: qr | Returns: object -- API response.
qr.generateUrlQr
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
generateTextQr
generateTextQr
Module: qr | Returns: object -- API response.
qr.generateTextQr
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
Error Handling
All functions throw on failure. Common errors:
| Error | Cause |
|---|---|
Qr API error (${res.status}): ${t} | Check the error message for details |
Qr: "..." not configured. Call qr.setCredentials first. | Check the error message for details |
@desc "Generate qr url and validate result"
do
set $result as qr.generateQrUrl
if $result != null
print "Success"
else
print "No result"
end
enddo
Recipes
1. Multi-step QR Code workflow
Chain multiple qr operations together.
@desc "Generate qr url, generate qr data url, and more"
do
set $r_generateQrUrl as qr.generateQrUrl
set $r_generateQrDataUrl as qr.generateQrDataUrl
set $r_generateWifiQr as qr.generateWifiQr
print "All operations complete"
enddo
2. Safe generateQrUrl with validation
Check results before proceeding.
@desc "Generate qr url and validate result"
do
set $result as qr.generateQrUrl
if $result != null
print "Success: " + $result
else
print "Operation returned no data"
end
enddo
Related Modules
- json -- JSON module for complementary functionality
Versions (1)
| Version | Tag | Published |
|---|---|---|
| 0.1.2 | latest | 1 months ago |
Related Modules
@robinpathv0.1.4
SMTP email sending and address parsing for RobinPath
hash
JS@robinpathv0.1.3
Cryptographic hashing utilities: MD5, SHA family, HMAC, CRC32, file hashing, UUID v5 generation, secure random bytes, and content fingerprinting
csv
JS@robinpathv0.1.2
Parse and stringify CSV data
apollo
JS@robinpathv0.1.2
Apollo module for RobinPath.
$ robinpath add @robinpath/qr
