Modules@robinpath/qr
qr

@robinpath/qr

0.1.2Node.jsPublic

QR 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.generateQrUrl to perform this operation
  • generateQrDataUrl -- Use qr.generateQrDataUrl to perform this operation
  • generateWifiQr -- Use qr.generateWifiQr to perform this operation
  • generateVCardQr -- Use qr.generateVCardQr to perform this operation
  • generateEmailQr -- Use qr.generateEmailQr to perform this operation

Quick Reference

FunctionDescriptionReturns
generateQrUrlgenerateQrUrlobject
generateQrDataUrlgenerateQrDataUrlobject
generateWifiQrgenerateWifiQrobject
generateVCardQrgenerateVCardQrobject
generateEmailQrgenerateEmailQrobject
generateSmsQrgenerateSmsQrobject
generateUrlQrgenerateUrlQrobject
generateTextQrgenerateTextQrobject

Functions

generateQrUrl

generateQrUrl

Module: qr | Returns: object -- API response.

qr.generateQrUrl
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateQrDataUrl

generateQrDataUrl

Module: qr | Returns: object -- API response.

qr.generateQrDataUrl
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateWifiQr

generateWifiQr

Module: qr | Returns: object -- API response.

qr.generateWifiQr
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateVCardQr

generateVCardQr

Module: qr | Returns: object -- API response.

qr.generateVCardQr
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateEmailQr

generateEmailQr

Module: qr | Returns: object -- API response.

qr.generateEmailQr
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateSmsQr

generateSmsQr

Module: qr | Returns: object -- API response.

qr.generateSmsQr
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateUrlQr

generateUrlQr

Module: qr | Returns: object -- API response.

qr.generateUrlQr
ParameterTypeRequiredDescription
inputstringNoInput parameter

generateTextQr

generateTextQr

Module: qr | Returns: object -- API response.

qr.generateTextQr
ParameterTypeRequiredDescription
inputstringNoInput parameter

Error Handling

All functions throw on failure. Common errors:

ErrorCause
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)

VersionTagPublished
0.1.2latest1 months ago
Install
$ robinpath add @robinpath/qr

Collaborators

Dumitru Balaban
Dumitru Balaban
@dumitru
View all @robinpath modules
Version0.1.2
LicenseMIT
Unpacked Size3.4 KB
Versions1
Weekly Downloads21
Total Downloads21
Stars0
Last Publish1 months ago
Created1 months ago

Keywords

Category

utilities