{"id":21765968,"url":"https://github.com/narazaka/fso","last_synced_at":"2025-04-13T15:11:14.383Z","repository":{"id":24083561,"uuid":"27470469","full_name":"Narazaka/fso","owner":"Narazaka","description":"fso - FileSystemObject is a objective fs interface like Pathname(ruby).","archived":false,"fork":false,"pushed_at":"2020-06-01T20:28:51.000Z","size":435,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T18:21:19.501Z","etag":null,"topics":["filesystem","filesystem-library","filesystems","pathname"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Narazaka.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-03T05:11:02.000Z","updated_at":"2020-12-29T04:03:32.000Z","dependencies_parsed_at":"2022-09-09T04:01:07.383Z","dependency_job_id":null,"html_url":"https://github.com/Narazaka/fso","commit_stats":null,"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Ffso","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Ffso/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Ffso/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Ffso/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Narazaka","download_url":"https://codeload.github.com/Narazaka/fso/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732484,"owners_count":21152852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filesystem","filesystem-library","filesystems","pathname"],"created_at":"2024-11-26T13:14:35.791Z","updated_at":"2025-04-13T15:11:14.355Z","avatar_url":"https://github.com/Narazaka.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[fso - FileSystemObject](https://github.com/Narazaka/fso)\n==========================\n\n\n[![npm](https://img.shields.io/npm/v/fso.svg)](https://www.npmjs.com/package/fso)\n[![npm license](https://img.shields.io/npm/l/fso.svg)](https://www.npmjs.com/package/fso)\n[![npm download total](https://img.shields.io/npm/dt/fso.svg)](https://www.npmjs.com/package/fso)\n[![npm download by month](https://img.shields.io/npm/dm/fso.svg)](https://www.npmjs.com/package/fso)\n[![dependencies Status](https://david-dm.org/Narazaka/fso/status.svg)](https://david-dm.org/Narazaka/fso)\n[![devDependencies Status](https://david-dm.org/Narazaka/fso/dev-status.svg)](https://david-dm.org/Narazaka/fso?type=dev)\n\n[![Travis Build Status](https://travis-ci.org/Narazaka/fso.svg?branch=master)](https://travis-ci.org/Narazaka/fso)\n[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/Narazaka/fso?svg=true\u0026branch=master)](https://ci.appveyor.com/project/Narazaka/fso)\n[![codecov.io](https://codecov.io/github/Narazaka/fso/coverage.svg?branch=master)](https://codecov.io/github/Narazaka/fso?branch=master)\n[![Code Climate](https://codeclimate.com/github/Narazaka/fso/badges/gpa.svg)](https://codeclimate.com/github/Narazaka/fso)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b0ffe17aa40b41a7a446f4d70808228f)](https://www.codacy.com/app/narazaka/fso?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=Narazaka/fso\u0026utm_campaign=badger)\n[![Greenkeeper badge](https://badges.greenkeeper.io/Narazaka/fso.svg)](https://greenkeeper.io/)\n\nfso - FileSystemObject is a objective fs interface like Pathname(ruby).\n\nInstallation\n--------------------------\n\n```\nnpm install fso\n```\n\nUsage\n--------------------------\n\nnode.js:\n```javascript\nvar fso = require('fso').default;\nvar FileSystemObject = require('fso').FileSystemObject;\n```\n\nES2015:\n```javascript\nimport fso, {FileSystemObject} from 'fso';\n```\n\nAPI\n--------------------------\n\n[API Documents (with type annotations)](https://narazaka.github.io/fso/index.html)\n\n### objective methods\n\n#### constructor\n\n```javascript\nvar abc = new FileSystemObject(\"a\", \"b\", \"c\");\nabc.toString() === \"a/b/c\"\n```\n\n#### new / join\n\n```javascript\ndir = fso.new('dir');\na = dir.new('a.txt');\na.writeFileSync('aaaaaa');\n```\n\n#### parent\n\n```javascript\ndir = fso.new('dir');\np = dir.parent();\ndir = p.new('dir');\n```\n\n#### children, childrenSync\n\n```javascript\ndir = fso.new('dir');\nfiles = dir.childrenSync();\n```\n\n#### childrenAll, childrenAllSync\n\n```javascript\ndir = fso.new('dir');\nfiles = dir.childrenAllSync();\n```\n\n#### filteredChildren, filteredChildrenSync, filteredChildrenAll, filteredChildrenAllSync\n\n```javascript\nexcepts = [\"ignore_file\", \"path/to/ignore_directory\"];\nentries = target.filteredChildrenAllSync(excepts);\n```\n\n```javascript\n// Sync\nexcepts = (entry) =\u003e entry.isDirectorySync();\nfiles = target.filteredChildrenAllSync(excepts); // childrenSync() minus directories\n```\n\n```javascript\n// Promise form condition also OK when Promise form call\nexcepts = (entry) =\u003e entry.isDirectory();\nfiles = await target.filteredChildrenAll(excepts);\n```\n\n```javascript\n// callback form also OK when callback form call\nexcepts = (entry, callback) =\u003e\n  entry.isDirectory(\n    (error, isDirectory) =\u003e callback(error, isDirectory)\n  );\ntarget.filteredChildrenAll(excepts, (error, files) =\u003e console.log(files.toString()));\n```\n\n### path\n\n#### path / toString\n\n```javascript\nfooPath = fso.new('foo').path;\nfooPath = fso.new('foo').toString();\n```\n\n### 'fs' API\n\nSupports all the node.js 'fs' APIs that needs no first path argument.\n\n`method(...args, callback)`, `methodSync(...args)` and `promise = method(...args)`\n\n#### one file args\n\n```javascript\nfs.truncateSync('/path/to/file', 0);\n// is\nfile = fso.new('/path/to/file');\nfile.truncateSync(0);\n```\n\n#### two file args\n\n```javascript\nfs.rename('/path/to/file', 'newfile', callback);\n// is\nfile = fso.new('/path/to/file');\nfile.remane('newfile', callback);\n```\n\n#### fd args\n\n```javascript\nfd = fs.openSync('/path/to/file');\nfs.ftruncateSync(fd, 0);\nfs.close(fd);\n// is\nfile = fso.new('/path/to/file');\nfile.openSync();\nfile.ftruncateSync(0);\nfile.close();\n```\n\n### convenient additional\n\n#### mkdirAll\n```javascript\nfso.new('long/deep/path/to').mkdirAll().then(...);\n```\n\n#### mkdirp (= mkdirAll)\n\n#### mkpath (= mkdirAll)\n\n#### readdirAll\n```javascript\ndir.readdirAllSync()\n// results\n['a.txt', 'aa', 'aa/a.txt', 'aa/b', 'aa/b/c.txt']\n```\n\n#### rmAll\n\n```javascript\nawait dir.rmAll('junk');\n```\n\n#### rmtree (= rmAll)\n\n#### mergeDirectory\n\n```javascript\ntarget.mergeDirectory(source);\n```\n\ncopy:\n\n```javascript\ntarget.rmAllSync();\ntarget.mergeDirectorySync(source);\n```\n\n#### filteredMergeDirectory\n\n```javascript\nexcepts = [\"ignore_file\", \"path/to/ignore_directory\"];\ntarget.filteredMergeDirectorySync(source, excepts);\n```\n\n```javascript\nexcepts = (entry) =\u003e entry.path === \"ignore_file\" || entry.path === \"path/to/ignore_directory\";\ntarget.filteredMergeDirectorySync(source, excepts);\n```\n\n#### isChildOf\n\n```javascript\ndir.new(\"foo/bar\").isChildOf(dir)\n```\n\n#### isParentOf\n\n```javascript\ndir.isParentOf(dir.new(\"foo/bar\"))\n```\n\n### path methods\n\n#### (property) delimiter\n```javascript\nfso.delimiter; // \":\" or \";\"\n```\n\n#### (property) sep\n```javascript\nfso.sep; // \"/\" or \"\\\\\"\n```\n\n#### (static) format\n```javascript\nvar entry = FileSystemObject.format({...});\n```\n\n#### parse\n```javascript\nvar parsedObject = fso.new(\"a\").parse();\n```\n\n#### normalize\n```javascript\nfso.new(\"a\").normalize(); // same as fso.new(\"a\")\n```\n\n#### basename\n```javascript\nfso.new(\"a/b/c\").basename(); // same as new FileSystemObject(\"c\")\n```\n\n#### dirname\nsame as parent()\n\n#### extname\n```javascript\nfso.new(\"a/b/c.txt\").extname(); // \".txt\"\n```\n\n#### isAbsolute\n```javascript\nfso.new(\"a/b/c.txt\").isAbsolute() === true\n```\n\n#### relative\n\n```javascript\nfso.new(\"a/b/c\").relative(fso.new(\"a/d\")); // same as new FileSystemObject(\"../d\")\nfso.new(\"/a/b/c\").relative(\"/a/d\"); // same as new FileSystemObject(\"../d\")\n```\n\n#### resolve\n```javascript\nfso.new(\"a/b/c\").resolve(\"/\") // same as new FileSystemObject(\"/a/b/c\")\n```\n\nLicense\n--------------------------\n\nThis is released under [Zlib License](http://narazaka.net/license/Zlib?2020).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnarazaka%2Ffso","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnarazaka%2Ffso","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnarazaka%2Ffso/lists"}