{"id":16695282,"url":"https://github.com/georgeosddev/jsonkey","last_synced_at":"2025-03-14T00:25:54.281Z","repository":{"id":24368415,"uuid":"27767601","full_name":"georgeOsdDev/jsonkey","owner":"georgeOsdDev","description":"Promised json key search","archived":false,"fork":false,"pushed_at":"2020-03-18T09:42:27.000Z","size":94,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-20T20:03:28.675Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://georgeosddev.github.io/jsonkey","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/georgeOsdDev.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-12-09T13:24:56.000Z","updated_at":"2014-12-12T15:18:46.000Z","dependencies_parsed_at":"2022-07-25T14:02:10.192Z","dependency_job_id":null,"html_url":"https://github.com/georgeOsdDev/jsonkey","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georgeOsdDev%2Fjsonkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georgeOsdDev%2Fjsonkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georgeOsdDev%2Fjsonkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georgeOsdDev%2Fjsonkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/georgeOsdDev","download_url":"https://codeload.github.com/georgeOsdDev/jsonkey/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243501755,"owners_count":20300947,"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":[],"created_at":"2024-10-12T17:06:19.249Z","updated_at":"2025-03-14T00:25:54.254Z","avatar_url":"https://github.com/georgeOsdDev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSONKey [![Build Status](https://travis-ci.org/georgeOsdDev/jsonkey.svg?branch=master)](https://travis-ci.org/georgeOsdDev/jsonkey) [![npm version](https://badge.fury.io/js/jsonkey.svg)](http://badge.fury.io/js/jsonkey)\n\n[![Sauce Test Status](https://saucelabs.com/browser-matrix/georgeosddev_jsonkey.svg)](https://saucelabs.com/u/georgeosddev_jsonkey)\n\nPromised json key search.\n\n## Usage\n\n### In Browser\n\nUse bower.\n```bash\nbower isntall jsonkey\n```\n\n```html\n\u003cscript src=\"./bower_components/jsonkey/dist/jsonkey_bundle.js\"\u003e\u003c/script\u003e\n```\n`JSONKey` will be installed to global.\n\n\n### In Node.js\nUse npm.\n\n```bash\nnpm isntall jsonkey\n```\n\n```javascript\nvar JSONKey = require(\"jsonkey\");\n```\n\n\n## API\n\n### Constructor\n\n```javascript\nvar parser = new JSONKey(/*timeout: Number*/);\n```\nCreate a json parser.\n\n#### params\n\n * `timeout` :Number :Optional(Default 100)\n\n   All promise created by `key` method will be rejected when specified milliseconds was past before key was found.\n\n### key\n\n```javascript\nvar findingName = parser.key(/*key: String*/);\n```\n\nCreate promise for value corresponding to specified key.\n\n#### params\n\n * `key` :String :Required\n\n   You can use dot notation for nested object and brackets for array index.\n\n#### example\n\n```javascript\n\nparser.key(\"name.last\")\n      .then(function(value){\n         console.log(\"LastName is \" + value);\n      });\n\nparser.key(\"favorites[0]\")\n      .then(function(value){\n         console.log(\"Fist favorite is \" + value);\n      })\nparser.key(\"address\")\n      .then(function(value){\n         console.log(value);\n      },function(){\n         console.log(\"address is not found\");\n      })\n\nvar jsonString = JSON.stringify({\n   name:{\n      last:\"aaa\",\n      first:\"bbb\"\n   },\n   age:50,\n   favorites:[\"book\",\"beer\"]\n});\nparser.parse(jsonString);\n// \"LastName is aaa\"\n// \"Fist favorite is book\"\n// \"address is not found\"\n```\n\n### filter, pipe, recovery, map, reduce, etc\n\n`promise` generated by `key` function is chain-able.\nSo easily create function chain as functional programming style.\nSee also APIs of [Promisechain](https://github.com/georgeOsdDev/promisechain).\n\n```javascript\n\n\nparser.key(\"items\")\n.map(function(item){\n   return item.price;\n})\n.reduce(function(acc, price){\n   return acc + price;\n}, 0)\n.pipe(function(val){\n   return \"TotalPrice is:\" + val;\n})\n.then(function(result){\n   console.log(result);\n});\n\n\nvar jsonString = JSON.stringify({\n   items:[\n      {name:\"book\",    price:10},\n      {name:\"apple\",   price:3},\n      {name:\"banana\",  price:2},\n      {name:\"water\",   price:1},\n   ]\n});\nparser.parse(jsonString);\n// =\u003e \"TotalPrice is: 16\"\n\n```\n\n\n\n### on, once, addListener, etc\n\n`JSONKey` inherits Node.js's build in `EventEmitter`.\nSo parser works as `EventEmitter` itself.\nEach key in jsonString will be emitted as event.\n\n#### example\n\n```javascript\nvar parser = new JSONKey();\nvar parser.on(\"age\", function(age){\n  console.log(\"He is \" + age + \"years old\");\n});\n\nvar jsonString = JSON.stringify({\n  name:{\n    last:\"aaa\",\n    first:\"bbb\"\n  },\n  age:50,\n  favorites:[\"book\",\"beer\"]\n});\nparser.parse(jsonString);\n```\n\n\n## Development\n\nInstall Node.js and NPM.\n\n```bash\ngit clone git://github.com/georegeosddev/jsonkey.git\ncd jsonkey\nnpm install\nnpm run-script build\n```\n\n\n## Licence\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeorgeosddev%2Fjsonkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeorgeosddev%2Fjsonkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeorgeosddev%2Fjsonkey/lists"}