{"id":15679502,"url":"https://github.com/jonschlinkert/option-cache","last_synced_at":"2025-10-17T22:05:48.551Z","repository":{"id":19537130,"uuid":"22785012","full_name":"jonschlinkert/option-cache","owner":"jonschlinkert","description":"Get and set options easily, for node.js projects.","archived":false,"fork":false,"pushed_at":"2020-04-01T00:06:21.000Z","size":105,"stargazers_count":13,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-24T05:38:15.533Z","etag":null,"topics":["cache","config","configuration","defaults","get","option","options","set","settings"],"latest_commit_sha":null,"homepage":"https://github.com/jonschlinkert","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/jonschlinkert.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-08-09T11:41:45.000Z","updated_at":"2025-05-13T09:02:19.000Z","dependencies_parsed_at":"2022-09-01T01:13:18.930Z","dependency_job_id":null,"html_url":"https://github.com/jonschlinkert/option-cache","commit_stats":null,"previous_names":["jonschlinkert/options-cache"],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/jonschlinkert/option-cache","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Foption-cache","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Foption-cache/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Foption-cache/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Foption-cache/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonschlinkert","download_url":"https://codeload.github.com/jonschlinkert/option-cache/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Foption-cache/sbom","scorecard":{"id":531976,"data":{"date":"2025-08-11","repo":{"name":"github.com/jonschlinkert/option-cache","commit":"f7f390b3b083f7885a63f2b15926ea5d88ecedfd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-20T05:56:52.181Z","repository_id":19537130,"created_at":"2025-08-20T05:56:52.182Z","updated_at":"2025-08-20T05:56:52.182Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279021001,"owners_count":26086946,"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","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","config","configuration","defaults","get","option","options","set","settings"],"created_at":"2024-10-03T16:32:15.098Z","updated_at":"2025-10-17T22:05:48.535Z","avatar_url":"https://github.com/jonschlinkert.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# option-cache [![NPM version](https://img.shields.io/npm/v/option-cache.svg?style=flat)](https://www.npmjs.com/package/option-cache) [![NPM monthly downloads](https://img.shields.io/npm/dm/option-cache.svg?style=flat)](https://npmjs.org/package/option-cache) [![NPM total downloads](https://img.shields.io/npm/dt/option-cache.svg?style=flat)](https://npmjs.org/package/option-cache) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/option-cache.svg?style=flat\u0026label=Travis)](https://travis-ci.org/jonschlinkert/option-cache)\n\n\u003e Simple API for managing options in JavaScript applications.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save option-cache\n```\n\n## Example app\n\nUse options-cache in your javascript application:\n\n```js\nvar util = require('util');\nvar Options = require('options-cache');\n\nfunction App(options) {\n  Options.call(this, options);\n  this.init();\n}\n\nutil.inherits(App, Options);\n\nApp.prototype.init = function() {\n  this.option('cwd', process.cwd());\n  this.option('foo', 'bar');\n};\n\nApp.prototype.a = function(value) {\n  this.enable(value);\n};\n\nApp.prototype.b = function(value) {\n  if (this.enabled(value)) {\n    // do something\n  } else {\n    // do something else\n  }\n};\n```\n\n## API\n\n### [Options](index.js#L24)\n\nCreate a new instance of `Options`.\n\n**Params**\n\n* `options` **{Object}**: Initialize with default options.\n\n**Example**\n\n```js\nvar app = new Options();\n```\n\n### [.option](index.js#L65)\n\nSet or get a default value. Defaults are cached on the `.defaults` object.\n\n**Params**\n\n* `key` **{String}**: The option name.\n* `value` **{any}**: The value to set.\n* `returns` **{any}**: Returns a `value` when only `key` is defined.\n\n**Example**\n\n```js\napp.default('admin', false);\napp.default('admin');\n//=\u003e false\n\napp.option('admin');\n//=\u003e false\n\napp.option('admin', true);\napp.option('admin');\n//=\u003e true\n```\n\n### [.option](index.js#L98)\n\nSet or get an option.\n\n**Params**\n\n* `key` **{String}**: The option name.\n* `value` **{any}**: The value to set.\n* `returns` **{any}**: Returns a `value` when only `key` is defined.\n\n**Example**\n\n```js\napp.option('a', true);\napp.option('a');\n//=\u003e true\n```\n\n**Params**\n\n* `key` **{String}**\n* `value` **{any}**\n* `type` **{String}**: Javascript native type (optional)\n* `returns` **{Object}**\n\n**Example**\n\n```js\napp.option('admin', true);\nconsole.log(app.either('admin', false));\n//=\u003e true\n\nconsole.log(app.either('collaborator', false));\n//=\u003e false\n```\n\n**Params**\n\n* `key` **{String}**\n* `value` **{any}**\n* `type` **{String}**: Javascript native type (optional)\n* `returns` **{Object}**\n\n**Example**\n\n```js\napp.option('a', 'b');\n\napp.fillin('a', 'z');\napp.fillin('x', 'y');\n\napp.option('a');\n//=\u003e 'b'\napp.option('x');\n//=\u003e 'y'\n```\n\n### [.hasOption](index.js#L204)\n\nReturn true if `options.hasOwnProperty(key)`\n\n**Params**\n\n* `prop` **{String}**\n* `returns` **{Boolean}**: True if `prop` exists.\n\n**Example**\n\n```js\napp.hasOption('a');\n//=\u003e false\napp.option('a', 'b');\napp.hasOption('a');\n//=\u003e true\n```\n\n### [.enable](index.js#L220)\n\nEnable `key`.\n\n**Params**\n\n* `key` **{String}**\n* `returns` **{Object}** `Options`: to enable chaining\n\n**Example**\n\n```js\napp.enable('a');\n```\n\n### [.disable](index.js#L237)\n\nDisable `key`.\n\n**Params**\n\n* `key` **{String}**: The option to disable.\n* `returns` **{Object}** `Options`: to enable chaining\n\n**Example**\n\n```js\napp.disable('a');\n```\n\n### [.enabled](index.js#L259)\n\nCheck if `prop` is enabled (truthy).\n\n**Params**\n\n* `prop` **{String}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\napp.enabled('a');\n//=\u003e false\n\napp.enable('a');\napp.enabled('a');\n//=\u003e true\n```\n\n### [.disabled](index.js#L281)\n\nCheck if `prop` is disabled (falsey).\n\n**Params**\n\n* `prop` **{String}**\n* `returns` **{Boolean}**: Returns true if `prop` is disabled.\n\n**Example**\n\n```js\napp.disabled('a');\n//=\u003e true\n\napp.enable('a');\napp.disabled('a');\n//=\u003e false\n```\n\n### [.isTrue](index.js#L308)\n\nReturns true if the value of `prop` is strictly `true`.\n\n**Params**\n\n* `prop` **{String}**\n* `returns` **{Boolean}**: Uses strict equality for comparison.\n\n**Example**\n\n```js\napp.option('a', 'b');\napp.isTrue('a');\n//=\u003e false\n\napp.option('c', true);\napp.isTrue('c');\n//=\u003e true\n\napp.option({a: {b: {c: true}}});\napp.isTrue('a.b.c');\n//=\u003e true\n```\n\n### [.isFalse](index.js#L335)\n\nReturns true if the value of `key` is strictly `false`.\n\n**Params**\n\n* `prop` **{String}**\n* `returns` **{Boolean}**: Uses strict equality for comparison.\n\n**Example**\n\n```js\napp.option('a', null);\napp.isFalse('a');\n//=\u003e false\n\napp.option('c', false);\napp.isFalse('c');\n//=\u003e true\n\napp.option({a: {b: {c: false}}});\napp.isFalse('a.b.c');\n//=\u003e true\n```\n\n### [.isBoolean](index.js#L359)\n\nReturn true if the value of key is either `true` or `false`.\n\n**Params**\n\n* `key` **{String}**\n* `returns` **{Boolean}**: True if `true` or `false`.\n\n**Example**\n\n```js\napp.option('a', 'b');\napp.isBoolean('a');\n//=\u003e false\n\napp.option('c', true);\napp.isBoolean('c');\n//=\u003e true\n```\n\n## Release history\n\n### v4.0.0\n\n**Breaking changes**\n\n* `.option` method no longer takes a list or array of objects\n* `.mergeOptions` was removed\n\n## About\n\n### Related projects\n\n* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base \"Framework for rapidly creating high quality node.js applications, using plugins like building blocks\")\n* [cache-base](https://www.npmjs.com/package/cache-base): Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects. | [homepage](https://github.com/jonschlinkert/cache-base \"Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.\")\n* [config-cache](https://www.npmjs.com/package/config-cache): General purpose JavaScript object storage methods. | [homepage](https://github.com/jonschlinkert/config-cache \"General purpose JavaScript object storage methods.\")\n* [map-cache](https://www.npmjs.com/package/map-cache): Basic cache object for storing key-value pairs. | [homepage](https://github.com/jonschlinkert/map-cache \"Basic cache object for storing key-value pairs.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 95 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [tunnckoCore](https://github.com/tunnckoCore) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme \u0026\u0026 verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 19, 2017._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Foption-cache","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonschlinkert%2Foption-cache","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Foption-cache/lists"}