@vayapin/pin-data-delivery
v0.14.2
Published
A npm package with utils to handle pin data sent by public API
Downloads
213
Readme
VayaPin PinDataDelivery
This package provides utilities to handle PinDataDelivery results from the public GraphQL API.
Mainly, you might want to pass the result from the API into the {@link processQueryData} method to get parsed results. Additionally, you can pass password information to decrypt protected fields.
API
|method|summary| |---|---| |{@link processQueryData}|Convert and decrypt information from the GraphQL public API. Mainly, it'll handle the pinDataDelivery information.| |{@link passwordCheck}|Test a given password if it's possible to decrypt information with it.| |{@link processBaseField}|When manually handling delivery fields, you might want to use this method to process a single base field| |{@link processFieldValue}|When manually handling delivery fields, you might want to use this method to process the value only|
Usage:
import { processQueryData } from '@vayapin/pin-data-delivery'
Typing
Types are found at https://www.npmjs.com/package/@vayapin/cs-types-public
Package related types can be found at Types.d.ts as well as inside the html docs.