diff options
author | Matthew Miller <matthew@millerti.me> | 2020-06-03 07:55:39 -0700 |
---|---|---|
committer | Matthew Miller <matthew@millerti.me> | 2020-06-03 07:55:39 -0700 |
commit | d695e4fe129d0bfbeaf34b4ee71de0b07e169921 (patch) | |
tree | 1e392251a80adfa7c9f71f48b297d194cfdf799c /packages/typescript-types/src | |
parent | 585f57e5e082dea38121dde3d60d17c87e208f53 (diff) |
Add some commenting to response JSON interfaces
Diffstat (limited to 'packages/typescript-types/src')
-rw-r--r-- | packages/typescript-types/src/index.ts | 8 |
1 files changed, 8 insertions, 0 deletions
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, |