Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

payid-lib

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

payid-lib

Simple PayID utility functions

  • 0.1.0
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

payid-lib

Simple PayID utility functions

Installation

$ yarn add payid-lib

or with npm:

$ npm install payid-lib

payid-lib API Reference

Functions

parsePayId(payId)

Parse a PayID into PayIdComponents.

isValidPayId(payId)

Check whether a string is syntactically a valid PayID.

resolvePayId(payId, options)

Retrieve one or more addresses associated with a PayID.

By default, this retrieves all of a PayID's addresses by passing the payid network in the header of the request.

To retrieve an address for a particular payment network, set options.network to the desired PaymentNetwork.

parsePayId(payId) ⇒

Parse a PayID into PayIdComponents.

Kind: global function
Returns: the PayIdComponents if the PayID is syntactically valid, otherwise undefined

ParamDescription
payIdthe PayID to parse

isValidPayId(payId) ⇒

Check whether a string is syntactically a valid PayID.

Kind: global function
Returns: true if the PayID is valid, otherwise false

ParamDescription
payIdthe PayID to check

resolvePayId(payId, options)

Retrieve one or more addresses associated with a PayID.

By default, this retrieves all of a PayID's addresses by passing the payid network in the header of the request.

To retrieve an address for a particular payment network, set options.network to the desired PaymentNetwork.

Kind: global function

ParamDescription
payIdThe PayID to resolve for one or more addresses
optionsOptions object
options.networkThe network to retrieve an address for
options.useInsecureHttpIf true, http will be used. Use for testing purposes only. Defaults to false

Development Environment

  • Node.js LTS
  • Yarn
  • TypeScript
  • Linting with eslint
  • Testing with Jest
  • Code coverage

Scripts

  • compile
    • Runs typescript (tsc) and outputs to ./dist
  • lint
    • Runs eslint (use --fix to automatically fix issues)
  • test
    • Runs jest testing framework
  • coverage
    • Collects code coverage information and outputs to ./coverage
  • docs
    • Generate README.md (from README.hbs and jsdoc2md) and ./docs (with typedoc)

FAQs

Package last updated on 22 Jun 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc