{"id":17472559,"url":"https://github.com/shinnn/app-cache-dir","last_synced_at":"2025-03-28T08:11:07.292Z","repository":{"id":57182501,"uuid":"95437543","full_name":"shinnn/app-cache-dir","owner":"shinnn","description":"Get a path of the standard cache directory for a given application","archived":false,"fork":false,"pushed_at":"2019-04-10T09:11:21.000Z","size":84,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-18T19:57:41.114Z","etag":null,"topics":["cache","cross-platform","directory","environment","javascript","nodejs","xdg"],"latest_commit_sha":null,"homepage":"https://github.com/atom/atom/issues/8281#issue-99784635","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":"2017-06-26T10:57:40.000Z","updated_at":"2019-04-10T09:11:22.000Z","dependencies_parsed_at":"2022-09-11T22:40:19.420Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/app-cache-dir","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fapp-cache-dir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fapp-cache-dir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fapp-cache-dir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fapp-cache-dir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/app-cache-dir/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":["cache","cross-platform","directory","environment","javascript","nodejs","xdg"],"created_at":"2024-10-18T17:26:55.792Z","updated_at":"2025-03-28T08:11:07.257Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","readme":"# app-cache-dir\n\n[![npm version](https://img.shields.io/npm/v/app-cache-dir.svg)](https://www.npmjs.com/package/app-cache-dir)\n[![Build Status](https://travis-ci.com/shinnn/app-cache-dir.svg?branch=master)](https://travis-ci.com/shinnn/app-cache-dir)\n[![codecov](https://codecov.io/gh/shinnn/app-cache-dir/branch/master/graph/badge.svg)](https://codecov.io/gh/shinnn/app-cache-dir)\n\nGet a path of the standard cache directory for a given application\n\n```javascript\nconst appCacheDir = require('app-cache-dir');\n\n// On most Linuxes\nappCacheDir('my-app'); //=\u003e '/root/shinnn/.cache/my-app'\n\n// On macOS\nappCacheDir('my-app'); //=\u003e '/Users/shinnn/.cache/my-app'\n\n// On Windows\nappCacheDir('my-app'); //=\u003e 'C:\\\\Users\\\\shinnn\\\\AppData\\\\Local\\\\my-app\\\\cache'\n```\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).\n\n```\nnpm install app-cache-dir\n```\n\n## API\n\n```javascript\nconst appCacheDir = require('app-cache-dir');\n```\n\n### appCacheDir(*appName*)\n\n*appName*: `string` (application name)  \nReturn: `string` (absolute directory path)\n\nIt resolves an application name into its [standard cache directory presented in the Atom issue tracker](https://github.com/atom/atom/issues/8281#issue-99784635), with following the environment variables [`XDG_CACHE_HOME`](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) (POSIX) and `LOCALAPPDATA` (Windows).\n\nBasically it results:\n\n* `~/.cache/${appName}` on POSIX\n* `C:\\\\Users\\\\${username}\\\\AppData\\Local\\${appName}\\cache` on Windows\n\n```javascript\n// On macOS\n\nappCacheDir('hi'); //=\u003e '/Users/shinnn/.cache/hi'\n\nprocess.env.XDG_CACHE_HOME = '/foo/bar/';\n\nappCacheDir('hi'); //=\u003e '/foo/bar/hi'\n```\n\nWhen it cannot resolve the cache path, for exmaple both `HOME` and `XDG_CACHE_HOME` are empty, it returns `${os.tmpdir()}/${appName}/cache` as a last resort.\n\n### appCacheDir.posix(*appName*)\n\n*appName*: `string`  \nReturn: `string`\n\nFollow POSIX way regardless of the current OS.\n\n### appCacheDir.win32(*appName*)\n\n*appName*: `string`  \nReturn: `string`\n\nFollow Windows way regardless of the current OS.\n\n## License\n\n[ISC License](./LICENSE) © 2017 - 2019 Shinnosuke Watanabe\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fapp-cache-dir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Fapp-cache-dir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fapp-cache-dir/lists"}