feat: export JWTOptions and JWTVerifyOptions parameter types (#198)

fixes #197
decentralized-identity · Aug 31, 2021 · 8ba42e7 · 8ba42e7
1 parent 7e4aab8
commit 8ba42e7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/src/JWT.ts b/src/JWT.ts
@@ -194,7 +194,9 @@ export function decodeJWT(jwt: string): JWTDecoded {
  *  @param    {Object}            payload           payload object
  *  @param    {Signer}            signer            a signer, see `ES256KSigner or `EdDSASigner`
  *  @param    {Object}            header            optional object to specify or customize the JWS header
- *  @return   {Promise<Object, Error>}              a promise which resolves with a JWS string or rejects with an error
+ *  @param    {Object}            options           can be used to trigger automatic canonicalization of header and
+ *                                                    payload properties
+ *  @return   {Promise<string>}                     a Promise which resolves to a JWS string or rejects with an error
  */
 export async function createJWS(
   payload: string | Partial<JWTPayload>,

diff --git a/src/index.ts b/src/index.ts
@@ -48,3 +48,5 @@ export {
   JWTPayload,
   JWTVerified,
 }
+
+export { JWTOptions, JWTVerifyOptions } from './JWT'