Skip to content

Commit

Permalink
Fix return value types in jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
dennisreimann committed May 11, 2019
1 parent 6cfb90f commit 003c0f6
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion src/decodeCert.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ import base64url from 'base64url'
import decodeUriComponent from 'decode-uri-component'
import untildify from 'untildify'
import { isAbsolute } from './utils'

/**
* decode a tls certificate from a base64 encoded url string.
* @param {String} certString base64url encoded string to decode
* @return {Promise} decoded certificate
* @return {String} decoded certificate
*/
const decodeCert = certString => {
if (!certString) {
Expand Down
2 changes: 1 addition & 1 deletion src/decodeMacaroon.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { isAbsolute } from './utils'
/**
* decode a binary macaroon as a base64 decoded url string.
* @param {String} macaroonPath Path to macaroon file.
* @return {Promise} decoded macaroon
* @return {String} decoded macaroon
*/
const decodeMacaroon = macaroonString => {
if (!macaroonString) {
Expand Down
2 changes: 1 addition & 1 deletion src/encodeCert.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import strictUriEncode from 'strict-uri-encode'
/**
* Encode a tls certificate as a base64 encoded url string.
* @param {String} certPath Path to vertificate file.
* @return {Promise} Encoded certificate
* @return {String} Encoded certificate
*/
const encodeCert = (input, format = 'utf8') => {
if (!input) {
Expand Down
2 changes: 1 addition & 1 deletion src/encodeMacaroon.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import strictUriEncode from 'strict-uri-encode'
/**
* Encode a binary macaroon as a base64 encoded url string.
* @param {String} macaroonPath Path to macaroon file.
* @return {Promise} Encoded macaroon
* @return {String} Encoded macaroon
*/
const encodeMacaroon = (input, format = 'hex') => {
if (!input) {
Expand Down

0 comments on commit 003c0f6

Please sign in to comment.