{"id":17472783,"url":"https://github.com/shinnn/output-file","last_synced_at":"2026-05-02T03:02:07.977Z","repository":{"id":23209735,"uuid":"26566630","full_name":"shinnn/output-file","owner":"shinnn","description":"Write a file and create its ancestor directories if needed","archived":false,"fork":false,"pushed_at":"2019-04-23T18:21:38.000Z","size":152,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-25T07:44:09.517Z","etag":null,"topics":["ancestor-directories","async","javascript","mkdir","mkdirp","nodejs","promise","writefile"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shinnn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-13T02:30:17.000Z","updated_at":"2020-12-24T02:55:25.000Z","dependencies_parsed_at":"2022-08-21T21:50:18.453Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/output-file","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Foutput-file","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Foutput-file/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Foutput-file/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Foutput-file/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/output-file/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245991582,"owners_count":20706129,"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":["ancestor-directories","async","javascript","mkdir","mkdirp","nodejs","promise","writefile"],"created_at":"2024-10-18T17:36:26.794Z","updated_at":"2026-05-02T03:02:02.954Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# output-file\n\n[![npm version](https://img.shields.io/npm/v/output-file.svg?style=flat)](https://www.npmjs.com/package/output-file)\n[![Build Status](https://travis-ci.com/shinnn/output-file.svg?branch=master)](https://travis-ci.com/shinnn/output-file)\n[![codecov](https://codecov.io/gh/shinnn/output-file/branch/master/graph/badge.svg)](https://codecov.io/gh/shinnn/output-file)\n\nWrite a file and create its ancestor directories if needed\n\n```javascript\nconst {readFile} = require('fs').promises;\nconst outputFile = require('output-file');\n\n(async () =\u003e {\n  await outputFile('foo/bar/baz.txt', 'Hi!');\n  await readFile('foo/bar/baz.txt', 'utf8'); //=\u003e 'Hi!'\n})();\n```\n\nThis module is very similar to [fs-extra](https://github.com/jprichardson/node-fs-extra)'s [`fs.outputFile`](https://github.com/jprichardson/node-fs-extra/blob/HEAD/docs/outputFile.md), but has the following features fs-extra doesn't have:\n\n* Support for various non-string path types – `Buffer`, `Uint8Array` and `URL`\n* An option to set mode of created directories\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).\n\n```\nnpm install output-file\n```\n\n## API\n\n```javascript\nconst outputFile = require('output-file');\n```\n\n### outputFile(*path*, *data* [, *options*])\n\n*path*: `string | Buffer | Uint8Array | URL`  \n*data*: `string | Buffer | TypedArray | DataView`  \n*options*: `Object` ([options](#options)) or `string` (file encoding)  \nReturn: `Promise\u003cundefined\u003e`\n\nIt writes the data to a file asynchronously. If ancestor directories of a file don't exist, it creates those directories before writing a file.\n\n```javascript\nconst {stat} = require('fs').promises;\nconst outputFile = require('output-file');\n\n// When the directory `foo/bar` exists\n\n(async () =\u003e {\n  await outputFile('foo/bar/baz/qux.txt', 'Hello');\n\n  (await stat('foo/bar/baz')).isDirectory(); //=\u003e true\n  (await stat('foo/bar/baz/qux.txt')).isFile(); //=\u003e true\n})();\n```\n\n#### options\n\nAll options for [`fs.promises.writeFile()`](https://nodejs.org/api/fs.html#fs_fspromises_writefile_file_data_options) and [`fs.promises.mkdir()`](https://nodejs.org/api/fs.html#fs_fspromises_mkdir_path_options), except for `mode` and `recursive`, are supported.\n\n`recursive` option is enabled by default and cannot be disabled.\n\nInstead of `mode` option, use the followings:\n\n##### options.fileMode\n\nSet mode of a file.\n\n##### options.dirMode\n\nSet mode of directories.\n\n```javascript\nconst {stat} = require('fs').promises;\nconst outputFile = require('output-file');\n\n(async () =\u003e {\n  await outputFile('dir/file', 'content', {\n    dirMode: '0745',\n    fileMode: '0644'\n  });\n\n  (await stat('dir')).mode.toString(8); //=\u003e '40745'\n  (await stat('dir/file')).mode.toString(8); //=\u003e '100644'\n})();\n```\n\n## Related project\n\n* [output-file-sync](https://github.com/shinnn/output-file-sync) (synchronous version)\n\n## License\n\n[ISC License](./LICENSE) © 2018 - 2019 Shinnosuke Watanabe\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Foutput-file","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Foutput-file","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Foutput-file/lists"}