chore: added jsdoc plus bump deps

dunosaurs · Dec 21, 2022 · 49c90a6 · 49c90a6
1 parent 5623734
commit 49c90a6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/deps.ts b/deps.ts
@@ -1,3 +1,3 @@
 export { writeAll } from "https://deno.land/[email protected]/streams/write_all.ts";
 export { assert } from "https://deno.land/[email protected]/testing/asserts.ts";
-export { parse } from "https://deno.land/std@0.168.0/flags/mod.ts";
+export { parse } from "https://deno.land/std@0.170.0/flags/mod.ts";
diff --git a/mod.ts b/mod.ts
@@ -13,10 +13,20 @@ function tokenize(text: string) {
   );
 }
 
+/**
+ * The options for TTS
+ */
 export interface SaveOptions {
   language: keyof typeof LANGUAGES;
 }
 
+/**
+ * Convert text to speech and save to a .wav file
+ * @example
+ * ```typescript
+ * await save("./demo.wav", "hello text to speech", { language: "en-us" });
+ * ```
+ */
 export async function save(
   path: string,
   text: string,