{"_id":"@aeontek/dictionary","_rev":"4-9eabdd591227dfaad115a30fa3426541","name":"@aeontek/dictionary","dist-tags":{"latest":"1.0.14"},"versions":{"1.0.8":{"name":"@aeontek/dictionary","version":"1.0.8","author":{"name":"Drew Long"},"license":"MIT","_id":"@aeontek/dictionary@1.0.8","maintainers":[{"name":"attanai","email":"drew@aeontek.org"}],"homepage":"https://github.com/aeontek/Dictionary#readme","bugs":{"url":"https://github.com/aeontek/Dictionary/issues"},"dist":{"shasum":"ecf9c0cfac834bfa22b113d4339bb6cb0879f8b4","tarball":"https://registry.npmjs.org/@aeontek/dictionary/-/dictionary-1.0.8.tgz","fileCount":6,"integrity":"sha512-KsuJhi7gqSEq5PMqxu6Ox5/BBaMx8Ciy+LMgHDb+4tFDDDHGd59CkYtkocxjjSA8wCPCOcHxnS0KBV+F2ewiSA==","signatures":[{"sig":"MEUCIG7Cvxxn9Al7i+ooNwjmYEVljooKri3kCNcpfyTo1b29AiEAqyJxR3+cCVBcnhcP+BIqNQewHiFuvvtETfbBLUrJ0q0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11697},"main":"dist/Dictionary.js","types":"./dist/Dictionary.d.ts","gitHead":"9353e2bd5e185e506ad001a2af0b2bce22b89920","scripts":{"test":"jest","build":"npx tsc && npx jsdoc2md --files dist/* > README.md"},"_npmUser":{"name":"attanai","email":"drew@aeontek.org"},"repository":{"url":"git+https://github.com/aeontek/Dictionary.git","type":"git"},"_npmVersion":"9.8.1","description":"An simple class for managing String-Indexed object arrays.","directories":{},"_nodeVersion":"18.18.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","babel-jest":"^29.7.0","typescript":"^5.2.2","@babel/core":"^7.22.20","@types/jest":"^29.5.5","@types/node":"^20.6.2","@babel/preset-env":"^7.22.20","jsdoc-to-markdown":"^8.0.0","@babel/preset-typescript":"^7.22.15"},"_npmOperationalInternal":{"tmp":"tmp/dictionary_1.0.8_1696715899269_0.7825196799506027","host":"s3://npm-registry-packages"}},"1.0.12":{"name":"@aeontek/dictionary","version":"1.0.12","author":{"name":"Drew Long"},"license":"MIT","_id":"@aeontek/dictionary@1.0.12","maintainers":[{"name":"attanai","email":"drew@aeontek.org"}],"homepage":"https://github.com/aeontek/Dictionary#readme","bugs":{"url":"https://github.com/aeontek/Dictionary/issues"},"dist":{"shasum":"11cc0e3dfb72fd8870441b9bc444daea6a1c6724","tarball":"https://registry.npmjs.org/@aeontek/dictionary/-/dictionary-1.0.12.tgz","fileCount":6,"integrity":"sha512-Mb/YwM9rxxHX+kA2iVfjPsGoPcMzIfM5dpSVPd01JCG+DRUhCU/T66mRnXzb1usbb0ohMi9sv7VvjvE4BexuIA==","signatures":[{"sig":"MEYCIQCfdJYGy2HcM9+wCggRsOpoHBTD5oNNJH8qzy0W+7mizAIhAKV5siAnTj9evv8fjTEgiBRSM2yMri4dfGX6BM7jQ8mE","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11677},"main":"dist/Dictionary.js","types":"./dist/Dictionary.d.ts","scripts":{"test":"jest","build":"npx tsc && npx jsdoc2md --files dist/* > README.md"},"_npmUser":{"name":"attanai","email":"drew@aeontek.org"},"repository":{"url":"git+https://github.com/aeontek/Dictionary.git","type":"git"},"_npmVersion":"9.8.1","description":"An simple class for managing String-Indexed object arrays.","directories":{},"_nodeVersion":"18.18.2","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","babel-jest":"^29.7.0","typescript":"^5.2.2","@babel/core":"^7.22.20","@types/jest":"^29.5.5","@types/node":"^20.6.2","@faker-js/faker":"^8.2.0","@babel/preset-env":"^7.22.20","jsdoc-to-markdown":"^8.0.0","@babel/preset-typescript":"^7.22.15"},"_npmOperationalInternal":{"tmp":"tmp/dictionary_1.0.12_1698673329421_0.6087451540365849","host":"s3://npm-registry-packages"}},"1.0.13":{"name":"@aeontek/dictionary","version":"1.0.13","author":{"name":"Drew Long"},"license":"MIT","_id":"@aeontek/dictionary@1.0.13","maintainers":[{"name":"attanai","email":"drew@aeontek.org"}],"homepage":"https://github.com/aeontek/Dictionary#readme","bugs":{"url":"https://github.com/aeontek/Dictionary/issues"},"dist":{"shasum":"30689c445e39c7c0d9af7330a7d4b4394e8dd779","tarball":"https://registry.npmjs.org/@aeontek/dictionary/-/dictionary-1.0.13.tgz","fileCount":6,"integrity":"sha512-hMVhLZc25+aZFME19d2f5uJrULp/eQhfT2X91N/Z9kDyjg6jK3pcydPaNlwBcF0OjFW8WcfLYRC+PNndEv4/FA==","signatures":[{"sig":"MEUCIAvD5Frva5uP5mtMCpqF3ZorAG1t3zix2IbbXKSb2u3yAiEA3M4hrcpnB1vLVzgkabNPHDc7XFV+8ASRb56PATpRyjs=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":14517},"main":"dist/Dictionary.js","types":"./dist/Dictionary.d.ts","scripts":{"test":"jest","build":"npx tsc && npx jsdoc2md --files dist/* > README.md"},"_npmUser":{"name":"attanai","email":"drew@aeontek.org"},"repository":{"url":"git+https://github.com/aeontek/Dictionary.git","type":"git"},"_npmVersion":"10.8.2","description":"An simple class for managing String-Indexed object arrays.","directories":{},"_nodeVersion":"18.20.7","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","babel-jest":"^29.7.0","typescript":"^5.2.2","@babel/core":"^7.22.20","@types/jest":"^29.5.5","@types/node":"^20.6.2","@faker-js/faker":"^8.2.0","@babel/preset-env":"^7.22.20","jsdoc-to-markdown":"^8.0.0","@babel/preset-typescript":"^7.22.15"},"_npmOperationalInternal":{"tmp":"tmp/dictionary_1.0.13_1740594464433_0.1820076759199316","host":"s3://npm-registry-packages-npm-production"}},"1.0.14":{"name":"@aeontek/dictionary","version":"1.0.14","description":"An simple class for managing String-Indexed object arrays.","main":"dist/Dictionary.js","scripts":{"build":"npx tsc && npx jsdoc2md --files dist/* > README.md","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/aeontek/Dictionary.git"},"author":{"name":"Drew Long"},"license":"MIT","devDependencies":{"@babel/core":"^7.22.20","@babel/preset-env":"^7.22.20","@babel/preset-typescript":"^7.22.15","@faker-js/faker":"^8.2.0","@types/jest":"^29.5.5","@types/node":"^20.6.2","babel-jest":"^29.7.0","jest":"^29.7.0","jsdoc-to-markdown":"^8.0.0","typescript":"^5.2.2"},"_id":"@aeontek/dictionary@1.0.14","types":"./dist/Dictionary.d.ts","bugs":{"url":"https://github.com/aeontek/Dictionary/issues"},"homepage":"https://github.com/aeontek/Dictionary#readme","_nodeVersion":"20.19.2","_npmVersion":"10.8.2","dist":{"integrity":"sha512-6gAwPN/A9HRqghB+yXne8Y1Ej1V+ZYBCb+T20DNqgLTmzj0bI9Gnc6CCvKd3GUZKo47sdBQaVhKKIty3C0o+Fg==","shasum":"4a04617c7fd9581e3fe2bc1205470eebef6e0cdf","tarball":"https://registry.npmjs.org/@aeontek/dictionary/-/dictionary-1.0.14.tgz","fileCount":6,"unpackedSize":14517,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDtHYeDyvy4Kmlh8hBi3+ypbEh9qc3PLP8/WKFPOAjZbQIgM6UvLuzzEokZCshIn/KXueoy8yWg54liXedBl6igWcw="}]},"_npmUser":{"name":"attanai","email":"drew@aeontek.org"},"directories":{},"maintainers":[{"name":"attanai","email":"drew@aeontek.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/dictionary_1.0.14_1749843785867_0.5649005206645157"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-07T21:58:19.182Z","modified":"2025-06-13T19:43:06.316Z","1.0.8":"2023-10-07T21:58:19.479Z","1.0.12":"2023-10-30T13:42:09.599Z","1.0.13":"2025-02-26T18:27:44.706Z","1.0.14":"2025-06-13T19:43:06.049Z"},"bugs":{"url":"https://github.com/aeontek/Dictionary/issues"},"author":{"name":"Drew Long"},"license":"MIT","homepage":"https://github.com/aeontek/Dictionary#readme","repository":{"type":"git","url":"git+https://github.com/aeontek/Dictionary.git"},"description":"An simple class for managing String-Indexed object arrays.","maintainers":[{"name":"attanai","email":"drew@aeontek.org"}],"readme":"<a name=\"Dictionary\"></a>\n\n## Dictionary\nClass for handling string-indexed objects. Similar to Dictionaries or Advanced Lists in other languages\n\n**Kind**: global class  \n\n* [Dictionary](#Dictionary)\n    * _instance_\n        * [.getById(id)](#Dictionary+getById) ⇒ <code>any</code>\n        * [.add(id)](#Dictionary+add)\n        * [.remove(id)](#Dictionary+remove) ⇒ <code>any</code>\n        * [.forEach(callback)](#Dictionary+forEach)\n        * [.map(callback)](#Dictionary+map) ⇒ <code>Array</code>\n        * [.getKeys()](#Dictionary+getKeys)\n        * [.sort(action, reverse)](#Dictionary+sort) ⇒ <code>Dictionary.&lt;T&gt;</code>\n    * _static_\n        * [.fromObject(obj)](#Dictionary.fromObject) ⇒ <code>Dictionary.&lt;T&gt;</code>\n\n<a name=\"Dictionary+getById\"></a>\n\n### dictionary.getById(id) ⇒ <code>any</code>\nGets the object listed under the specific ID. If no such item exists, returns null\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n**Returns**: <code>any</code> - The object identified by the unique identifier  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | <code>string</code> | The unique identifier for the specified object |\n\n<a name=\"Dictionary+add\"></a>\n\n### dictionary.add(id)\nAdds an object with a unique ID. If the ID is already taken, throws an error.\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n**Throws**:\n\n- Invalid Identifier\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | <code>string</code> | The unique identifier for the specified object |\n\n<a name=\"Dictionary+remove\"></a>\n\n### dictionary.remove(id) ⇒ <code>any</code>\nRemoves the object listed under the specific ID and returns the deleted object. If no such item exists, returns null\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n**Returns**: <code>any</code> - The deleted object identified by the unique identifier  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | <code>string</code> | The unique identifier for the specified object |\n\n<a name=\"Dictionary+forEach\"></a>\n\n### dictionary.forEach(callback)\nIterates through the Ditcionary and performs an action on each item\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| callback | <code>function</code> | The Action to be performed on each iteration |\n\n<a name=\"Dictionary+map\"></a>\n\n### dictionary.map(callback) ⇒ <code>Array</code>\nIterates through the Ditcionary and performs an action on each item, returning an array of the iterated results.\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n**Returns**: <code>Array</code> - An array of the iterated results.  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| callback | <code>function</code> | The Action to be performed on each iteration |\n\n<a name=\"Dictionary+getKeys\"></a>\n\n### dictionary.getKeys()\nLists all the keys used in the Dictionary\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n<a name=\"Dictionary+sort\"></a>\n\n### dictionary.sort(action, reverse) ⇒ <code>Dictionary.&lt;T&gt;</code>\nOrder By Key or Value\nThis is different than the sort function in that it returns a new Dictionary<T> rather than sorting the existing one\n\n**Kind**: instance method of [<code>Dictionary</code>](#Dictionary)  \n**Returns**: <code>Dictionary.&lt;T&gt;</code> - A new Dictionary<T> sorted by the specified action  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| action | <code>function</code> | The action to be performed on each item |\n| reverse | <code>boolean</code> | Whether to reverse the order of the sort |\n\n<a name=\"Dictionary.fromObject\"></a>\n\n### Dictionary.fromObject(obj) ⇒ <code>Dictionary.&lt;T&gt;</code>\nCreated a Dictionary<T> from a JavaScript object\n\n**Kind**: static method of [<code>Dictionary</code>](#Dictionary)  \n\n| Param | Type |\n| --- | --- |\n| obj | <code>Object</code> | \n\n","readmeFilename":"README.md"}