Add text library helpers

README.md

@@ -58,6 +58,10 @@ You can import and use these helper functions directly, or treat them as a start
 
 TBD API
 
+### TXT
+
+TBD API
+
 ### JSON
 
 TBD API
@@ -82,7 +86,7 @@ TBD API
 
 Run all the tests:
 
-`deno test -A tests/*`
+`deno test -A --unstable tests/*`
 
 Run separate tests
 

examples/txt/text-write.txt

@@ -0,0 +1 @@
+Writing test

examples/txt/text-write2.txt

@@ -0,0 +1 @@
+Write to a file

examples/txt/text.txt

@@ -0,0 +1 @@
+Test file to read

examples/txt/txt-example.ts

@@ -0,0 +1,13 @@
+import { readTXT, writeTXT } from '../../src/txt.ts' // replace with latest library https://deno.land/x/[email protected]/mod.ts
+
+// Path to a csv file
+const readTXTPath = './examples/txt/text.txt'
+const writeTXTPath = './examples/txt/text-write.txt'
+const content = 'Writing test'
+
+// read from a text file
+const text = await readTXT(readTXTPath)
+console.log(text)
+
+// write a text file
+await writeTXT(writeTXTPath, content)

mod.ts

@@ -3,4 +3,5 @@ export * from './src/csv.ts'
 export * from './src/image.ts'
 export * from './src/xlsx.ts'
 export * from './src/zip.ts'
-export * from './src/remove.ts'
+export * from './src/remove.ts'
+export * from './src/txt.ts'

src/txt.ts

@@ -0,0 +1,8 @@
+export async function readTXT(path: string) {
+    const text = await Deno.readTextFile(path)
+    return text
+}
+
+export async function writeTXT(path: string, text: string) {
+    await Deno.writeTextFile(path, text)
+}

tests/txt-test.ts

@@ -0,0 +1,20 @@
+import { assertStringIncludes } from "https://deno.land/[email protected]/testing/asserts.ts"
+import { readTXT, writeTXT } from '../src/txt.ts'
+
+const txtReadPath = './examples/txt/text.txt'
+const jsonWritePath = './examples/txt/text-write2.txt'
+
+Deno.test("reads a txt file", async () => {
+    const txt = await readTXT(txtReadPath)
+    console.log(txt)
+
+    assertStringIncludes(txt, 'Test file to read');
+})
+
+Deno.test("writes a txt file", async () => {
+    const content = 'Write to a file'
+    await writeTXT(jsonWritePath, content)
+    const txt = await readTXT(jsonWritePath)
+
+    assertStringIncludes(txt, content);
+})