update exports style, add types

jackyzha0 · Feb 11, 2022 · c71bab6 · c71bab6
1 parent c25c76e
commit c71bab6
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,10 @@ The package exports a function called `createTelescopicText` that returns a HTML
 Basic usage may look something like this:
 
 ```html
+<head>
+    <script src="https://unpkg.com/telescopic-text/index.js"></script>
+    <link href="https://unpkg.com/telescopic-text/index.css" rel="stylesheet">
+</head>
 <div id="text-container"></div>
 
 <script>
@@ -33,4 +37,22 @@ Basic usage may look something like this:
     const container = document.getElementById("text-container")
     container.appendChild(node)
 </script>
+```
+
+## Types
+```typescript
+interface Content {
+  text: string          // Original string content in the line
+  replacements: Line[]  // Sections of the original text to replace/expand
+}
+
+interface Line {
+  og: string           // the original string to replace
+  new: string          // the replacement string
+  replacements: Line[] // nested replacements to apply on the resultant line afterwards
+}
+
+// Default function to create a new `<div>` node containing the
+// telescoping text.
+function createTelescopicText(content: Content[])
 ```
diff --git a/index.js b/index.js
@@ -4,10 +4,10 @@
 // interface Line {
 //    og: string          // the original string to replace
 //    new: string         // the replacement string
-//    replacement: Line[] // nested replacements to apply on the resultant line afterwards
+//    replacements: Line[] // nested replacements to apply on the resultant line afterwards
 // }
 // ```
-export function hydrate(line, node) {
+function hydrate(line, node) {
   let lineText = line.text || line.og
 
   if (line.replacements.length > 0) {
@@ -80,7 +80,7 @@ export function hydrate(line, node) {
 //    replacements: Line[]  // Sections of the original text to replace/expand
 // }
 // ```
-export function createTelescopicText(content) {
+function createTelescopicText(content) {
   const letter = document.createElement("div")
   letter.id = "telescope"
   content.forEach(line => {
@@ -94,4 +94,6 @@ export function createTelescopicText(content) {
   return letter
 }
 
-
+module.exports = {
+  createTelescopicText, hydrate
+}