From d695e4fe129d0bfbeaf34b4ee71de0b07e169921 Mon Sep 17 00:00:00 2001
From: Matthew Miller <matthew@millerti.me>
Date: Wed, 3 Jun 2020 07:55:39 -0700
Subject: Add some commenting to response JSON interfaces

---
 packages/typescript-types/src/index.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'packages/typescript-types')

diff --git a/packages/typescript-types/src/index.ts b/packages/typescript-types/src/index.ts
index 56d420a..772184f 100644
--- a/packages/typescript-types/src/index.ts
+++ b/packages/typescript-types/src/index.ts
@@ -72,12 +72,20 @@ export interface AssertionCredentialJSON
   response: AuthenticatorAssertionResponseJSON;
 }
 
+/**
+ * A slightly-modified AuthenticatorAttestationResponse to simplify working with ArrayBuffers that
+ * are Base64URL-encoded in the browser so that they can be sent as JSON to the server.
+ */
 export interface AuthenticatorAttestationResponseJSON
   extends Omit<AuthenticatorAttestationResponse, 'clientDataJSON' | 'attestationObject'> {
   clientDataJSON: Base64URLString;
   attestationObject: Base64URLString;
 }
 
+/**
+ * A slightly-modified AuthenticatorAssertionResponse to simplify working with ArrayBuffers that
+ * are Base64URL-encoded in the browser so that they can be sent as JSON to the server.
+ */
 export interface AuthenticatorAssertionResponseJSON
   extends Omit<
     AuthenticatorAssertionResponse,
-- 
cgit v1.2.3