Update README

azu · Jun 2, 2019 · 393eab1 · 393eab1
1 parent 091042e
commit 393eab1
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,9 @@ It wrap `fs` module.
 
 ```js
 import {createKoreFile, createFsAdaptor} from "korefile";
-const koreFile = createKoreFile(createFsAdaptor());
+const koreFile = createKoreFile({ 
+    adaptor: createFsAdaptor()
+});
 (async () => { 
     // write
     await koreFile.writeFile("/path/to/file", "content");
@@ -46,12 +48,14 @@ Require [GitHub Auth Token](https://github.com/settings/tokens/new).
 
 ```js
 import {createKoreFile, createGitHubAdaptor} from "korefile";
-const koreFile = createKoreFile(createGitHubAdaptor({
-    owner: "azu",
-    repo: "korefile",
-    ref: "heads/test",
-    token: process.env.GH_TOKEN // https://github.com/settings/tokens/new
-}));
+const koreFile = createKoreFile({
+    adaptor: createGitHubAdaptor({
+        owner: "azu",
+        repo: "korefile",
+        ref: "heads/test",
+        token: process.env.GH_TOKEN
+    })
+});
 (async () => { 
     // file path should be relative
     const testFilePath = "file.test";

diff --git a/src/korefile.ts b/src/korefile.ts
@@ -8,7 +8,7 @@ export interface KoreFile {
     deleteFile(filePath: string): Promise<void>;
 }
 
-export const createKoreFile = (adaptor: KoreFileAdaptor): KoreFile => {
+export const createKoreFile = ({ adaptor }: { adaptor: KoreFileAdaptor }): KoreFile => {
     return {
         deleteFile(filePath: string): Promise<void> {
             return adaptor.deleteFile(filePath);

diff --git a/test/GitHubAdapter.test.ts b/test/GitHubAdapter.test.ts
@@ -5,12 +5,14 @@ const testFilePath = "dir/file.test";
 const it = process.env.GH_TOKEN ? global.it : global.it.skip;
 describe("GitHubAdapter", function() {
     it("write -> read -> delete", async () => {
-        const koreFile = createKoreFile(createGitHubAdaptor({
-            owner: "azu",
-            repo: "korefile",
-            ref: "heads/test",
-            token: process.env.GH_TOKEN
-        }));
+        const koreFile = createKoreFile({
+            adaptor: createGitHubAdaptor({
+                owner: "azu",
+                repo: "korefile",
+                ref: "heads/test",
+                token: process.env.GH_TOKEN
+            })
+        });
         const input = "content";
         await koreFile.writeFile(testFilePath, input);
         const content = await koreFile.readFile(testFilePath);

diff --git a/test/fsAdaptor.test.ts b/test/fsAdaptor.test.ts
@@ -13,7 +13,9 @@ describe("fsAdaptor", function() {
         }
     });
     it("write -> read -> delete", async () => {
-        const koreFile = createKoreFile(createFsAdaptor());
+        const koreFile = createKoreFile({
+            adaptor: createFsAdaptor()
+        });
         const input = "content";
         await koreFile.writeFile(testFilePath, input);
         const content = await koreFile.readFile(testFilePath);