File System API for Local/GitHub.
npm install korefile- Write/Read/Delete API for Local/GitHub
- Pluggable adaptor
Install with npm:
npm install korefile
Korefile apply KoreFileAdaptor implementation.
Read/Write/Delete for local file system.
It wraps fs module.
``js`
import {createKoreFile, createFsAdaptor} from "korefile";
const koreFile = createKoreFile({
adaptor: createFsAdaptor()
});
(async () => {
// write
await koreFile.writeFile("/path/to/file", "content");
// read
const content = await koreFile.readFile("/path/to/file");
// delete
await koreFile.deleteFile("/path/to/file");
})()
Read/Write/Delete for GitHub repository.
It wrap octokit/rest.js.
Require GitHub Auth Token.
`js`
import {createKoreFile, createGitHubAdaptor} from "korefile";
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";
// write
await koreFile.writeFile(testFilePath, input);
// read
const content = await koreFile.readFile(testFilePath);
// delete
await koreFile.deleteFile(testFilePath);
})();
- asocial-bookmark
- github-funding-yml-updater
See Releases page.
Install devDependencies and Run npm test:
npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes:
4. Push to the branch:
5. Submit a pull request :D
MIT © azu