{"id":23529628,"url":"https://github.com/jaid/read-file-yaml","last_synced_at":"2026-04-19T05:33:19.582Z","repository":{"id":51116912,"uuid":"229141810","full_name":"Jaid/read-file-yaml","owner":"Jaid","description":"Reads YAML 1.2 from a file. Returns null if file does not exist (or is a directory) instead of throwing an Error.","archived":false,"fork":false,"pushed_at":"2023-03-08T04:38:33.000Z","size":4994,"stargazers_count":1,"open_issues_count":9,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-26T07:32:37.930Z","etag":null,"topics":["file","filesystem","fs","lib","library","loader","promise","read-file","read-yaml","util","utility","yaml","yaml-parser","yml","yml-parser"],"latest_commit_sha":null,"homepage":"https://github.com/Jaid/read-file-yaml","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jaid.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/funding.yml","license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Jaid","custom":"https://twitch.tv/products/jaidchen"}},"created_at":"2019-12-19T21:30:09.000Z","updated_at":"2023-03-10T09:05:28.000Z","dependencies_parsed_at":"2024-11-15T22:03:02.724Z","dependency_job_id":"8b688133-0ea6-4c99-bc0c-541f8185f141","html_url":"https://github.com/Jaid/read-file-yaml","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Fread-file-yaml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Fread-file-yaml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Fread-file-yaml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Fread-file-yaml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jaid","download_url":"https://codeload.github.com/Jaid/read-file-yaml/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239226670,"owners_count":19603301,"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":["file","filesystem","fs","lib","library","loader","promise","read-file","read-yaml","util","utility","yaml","yaml-parser","yml","yml-parser"],"created_at":"2024-12-25T21:12:35.382Z","updated_at":"2025-10-17T11:40:36.902Z","avatar_url":"https://github.com/Jaid.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Jaid","https://twitch.tv/products/jaidchen","https://github.com/sponsors/jaid"],"categories":[],"sub_categories":[],"readme":"# read-file-yaml\n\n\n\u003ca href=\"https://raw.githubusercontent.com/jaid/read-file-yaml/master/license.txt\"\u003e\u003cimg src=\"https://img.shields.io/github/license/jaid/read-file-yaml?style=flat-square\" alt=\"License\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/sponsors/jaid\"\u003e\u003cimg src=\"https://img.shields.io/badge/\u003c3-Sponsor-FF45F1?style=flat-square\" alt=\"Sponsor read-file-yaml\"/\u003e\u003c/a\u003e  \n\u003ca href=\"https://actions-badge.atrox.dev/jaid/read-file-yaml/goto\"\u003e\u003cimg src=\"https://img.shields.io/endpoint.svg?style=flat-square\u0026url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fread-file-yaml%2Fbadge\" alt=\"Build status\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/read-file-yaml/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/commits-since/jaid/read-file-yaml/v2.0.0?style=flat-square\u0026logo=github\" alt=\"Commits since v2.0.0\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/read-file-yaml/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/jaid/read-file-yaml?style=flat-square\u0026logo=github\" alt=\"Last commit\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/read-file-yaml/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/jaid/read-file-yaml?style=flat-square\u0026logo=github\" alt=\"Issues\"/\u003e\u003c/a\u003e  \n\u003ca href=\"https://npmjs.com/package/read-file-yaml\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/read-file-yaml?style=flat-square\u0026logo=npm\u0026label=latest%20version\" alt=\"Latest version on npm\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/read-file-yaml/network/dependents\"\u003e\u003cimg src=\"https://img.shields.io/librariesio/dependents/npm/read-file-yaml?style=flat-square\u0026logo=npm\" alt=\"Dependents\"/\u003e\u003c/a\u003e \u003ca href=\"https://npmjs.com/package/read-file-yaml\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/read-file-yaml?style=flat-square\u0026logo=npm\" alt=\"Downloads\"/\u003e\u003c/a\u003e\n\n**Reads YAML 1.2 from a file. Returns null if file does not exist (or is a directory) instead of throwing an Error.**\n\n\n\n\n\n## Installation\n\n\u003ca href=\"https://npmjs.com/package/read-file-yaml\"\u003e\u003cimg src=\"https://img.shields.io/badge/npm-read--file--yaml-C23039?style=flat-square\u0026logo=npm\" alt=\"read-file-yaml on npm\"/\u003e\u003c/a\u003e\n\n```bash\nnpm install --save read-file-yaml@^2.0.0\n```\n\n\u003ca href=\"https://yarnpkg.com/package/read-file-yaml\"\u003e\u003cimg src=\"https://img.shields.io/badge/Yarn-read--file--yaml-2F8CB7?style=flat-square\u0026logo=yarn\u0026logoColor=white\" alt=\"read-file-yaml on Yarn\"/\u003e\u003c/a\u003e\n\n```bash\nyarn add read-file-yaml@^2.0.0\n```\n\n\u003ca href=\"https://github.com/jaid/read-file-yaml/packages\"\u003e\u003cimg src=\"https://img.shields.io/badge/GitHub Packages-@jaid/read--file--yaml-24282e?style=flat-square\u0026logo=github\" alt=\"@jaid/read-file-yaml on GitHub Packages\"/\u003e\u003c/a\u003e  \n(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))\n\n```bash\nnpm install --save @jaid/read-file-yaml@^2.0.0\n```\n\n\n\n## Example\n\n\n```javascript\nimport readFileYaml from \"read-file-yaml\"\n\nreadFileYaml(\"./exists.yml\").then(result =\u003e {\n\n})\n\nreadFileYaml(\"./doesNotExist.yml\").then(result2 =\u003e {\n\n})\n```\n\nVariable `result` will be:\n\n```javascript\n[\"a\", \"b\", \"c\"]\n```\nVariable `result2` will be:\n\n```javascript\nnull\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## Development\n\n\n\nSetting up:\n```bash\ngit clone git@github.com:jaid/read-file-yaml.git\ncd read-file-yaml\nnpm install\n```\nTesting:\n```bash\nnpm run test:dev\n```\nTesting in production environment:\n```bash\nnpm run test\n```\n\n\n## License\n[MIT License](https://raw.githubusercontent.com/jaid/read-file-yaml/master/license.txt)  \nCopyright © 2020, Jaid \\\u003cjaid.jsx@gmail.com\u003e (https://github.com/jaid)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaid%2Fread-file-yaml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaid%2Fread-file-yaml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaid%2Fread-file-yaml/lists"}