summaryrefslogtreecommitdiffhomepage
path: root/packages/typescript-types/src
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2020-05-29 15:34:02 -0700
committerGitHub <noreply@github.com>2020-05-29 15:34:02 -0700
commit2691bad472972664e2c5184e8708cf973beb5d55 (patch)
treeb20976e53e5573ca3779ba8177dd2a6b56cc15d0 /packages/typescript-types/src
parentd8d4f48f49da9f5b0310f462f994f42698e6b6b1 (diff)
parent94b461cfea0f365797a0e09865671f63e14ca7df (diff)
Merge pull request #19 from MasterKale/feature/docs
feature/docs
Diffstat (limited to 'packages/typescript-types/src')
-rw-r--r--packages/typescript-types/src/index.ts5
1 files changed, 5 insertions, 0 deletions
diff --git a/packages/typescript-types/src/index.ts b/packages/typescript-types/src/index.ts
index 920fd7c..dcd88a9 100644
--- a/packages/typescript-types/src/index.ts
+++ b/packages/typescript-types/src/index.ts
@@ -1,4 +1,9 @@
/**
+ * @packageDocumentation
+ * @module @simplewebauthn/typescript-types
+ * @preferred
+ */
+/**
* A variant of PublicKeyCredentialCreationOptions suitable for JSON transmission to the browser to
* (eventually) get passed into navigator.credentials.create(...) in the browser.
*/