{"id":16698068,"url":"https://github.com/arlac77/expression-expander","last_synced_at":"2025-04-10T02:54:29.449Z","repository":{"id":36896771,"uuid":"41203778","full_name":"arlac77/expression-expander","owner":"arlac77","description":"expands ${to be evaluated} expressions in object graphs","archived":false,"fork":false,"pushed_at":"2025-04-06T00:06:24.000Z","size":2666,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T00:24:16.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"0bsd","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arlac77.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-08-22T11:13:28.000Z","updated_at":"2025-04-06T00:06:26.000Z","dependencies_parsed_at":"2023-10-14T19:39:02.214Z","dependency_job_id":"64e02fab-d8c9-4f8e-84b4-d0ef1f01dbb3","html_url":"https://github.com/arlac77/expression-expander","commit_stats":{"total_commits":1308,"total_committers":10,"mean_commits":130.8,"dds":"0.18577981651376152","last_synced_commit":"e90e8281d146cf2b98be7d06e6145cd624103078"},"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fexpression-expander","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fexpression-expander/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fexpression-expander/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fexpression-expander/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arlac77","download_url":"https://codeload.github.com/arlac77/expression-expander/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248147404,"owners_count":21055540,"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:50:37.756Z","updated_at":"2025-04-10T02:54:29.406Z","avatar_url":"https://github.com/arlac77.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm](https://img.shields.io/npm/v/expression-expander.svg)](https://www.npmjs.com/package/expression-expander)\n[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)\n[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\\\u0026label\\\u0026labelColor=blue\\\u0026color=555555)](https://typescriptlang.org)\n[![bundlejs](https://deno.bundlejs.com/?q=expression-expander\\\u0026badge=detailed)](https://bundlejs.com/?q=expression-expander)\n[![downloads](http://img.shields.io/npm/dm/expression-expander.svg?style=flat-square)](https://npmjs.org/package/expression-expander)\n[![GitHub Issues](https://img.shields.io/github/issues/arlac77/expression-expander.svg?style=flat-square)](https://github.com/arlac77/expression-expander/issues)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fexpression-expander%2Fbadge\\\u0026style=flat)](https://actions-badge.atrox.dev/arlac77/expression-expander/goto)\n[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/expression-expander/badge.svg)](https://snyk.io/test/github/arlac77/expression-expander)\n[![Coverage Status](https://coveralls.io/repos/arlac77/expression-expander/badge.svg)](https://coveralls.io/github/arlac77/expression-expander)\n\n## Expression Expander\n\nExpands *\\\\${to be evaluated}* expressions in object graphs. The actual expression syntax inside of the *\\\\${evaluated}* is not defined within this module (only simple key lookup)\n\n# example\n\n## file.js\n\n\u003c!-- skip-example --\u003e\n\n```js\nimport { createContext } from \"expression-expander\";\n\nconst context = createContext();\n\ncontext.properties = { aKey: \"aValue\", moreKeys: { a: 1, b: 2 } };\n\n// expanding whole expressions at the key position\nconsole.log(\n  JSON.stringify(\n    context.expand({ simple: \"${aKey}\", complex: { \"${moreKeys}\": {} } })\n  )\n);\n```\n\nOutput\n\n```json\n{ \"simple\": \"aValue\", \"complex\": { \"a\": 1, \"b\": 2 } }\n```\n\n## Any Object of the following types may be expanded\n\n*   String\n*   Number\n*   BigInt\n*   Buffer\n*   Object (key and value will be expanded)\n*   Array\n*   Map (key and value will be expanded)\n*   Set\n*   Boolean\n*   Promise\n\n# API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n### Table of Contents\n\n*   [Evaluator](#evaluator)\n    *   [Parameters](#parameters)\n*   [PathEntry](#pathentry)\n    *   [Properties](#properties)\n*   [Quoter](#quoter)\n    *   [Parameters](#parameters-1)\n*   [Expander](#expander)\n    *   [Parameters](#parameters-2)\n*   [ExpressionExpander](#expressionexpander)\n    *   [Properties](#properties-1)\n*   [createContext](#createcontext)\n    *   [Parameters](#parameters-3)\n*   [expand](#expand)\n    *   [Parameters](#parameters-4)\n*   [properties](#properties-2)\n\n## Evaluator\n\nType: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)\n\n### Parameters\n\n*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**\u0026#x20;\n*   `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**\u0026#x20;\n*   `path` **\\[[PathEntry](#pathentry)]**\u0026#x20;\n\nReturns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** expression evaluation result\n\n## PathEntry\n\nType: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n### Properties\n\n*   `value` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**\u0026#x20;\n\n## Quoter\n\nType: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)\n\n### Parameters\n\n*   `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** to be quoted\n\nReturns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** quoted value\n\n## Expander\n\nType: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)\n\n### Parameters\n\n*   `value` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) | bigint | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map) | [Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set))**\u0026#x20;\n*   `path` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u003c[PathEntry](#pathentry)\u003e?**\u0026#x20;\n\nReturns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) | bigint | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map) | [Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set))** expression evaluation result\n\n## ExpressionExpander\n\nType: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n### Properties\n\n*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**\u0026#x20;\n*   `expand` **[Expander](#expander)**\u0026#x20;\n\n## createContext\n\nCreates a new expansion context\n\n### Parameters\n\n*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** object with the following keys\n\n    *   `options.leftMarker` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** lead in of expression\n    *   `options.rightMarker` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** lead out of expression\n    *   `options.markerRegexp` **([RegExp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** expression with lead in / out\n    *   `options.valueQuoter` **[Quoter](#quoter)?** to quote expanded values\n        by default no special quoting is done and the evaluated result will be direcly\n        inserted into the output string\n    *   `options.evaluate` **[Evaluator](#evaluator)?** evaluate(expression,context,path) function to evaluate expressions\n        the default evaluation function does a lookup into the properties\n    *   `options.keepUndefinedValues` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true: is expression resolves to undefind the original string will be used (with surrounding ${})\n    *   `options.maxNestingLevel` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** max number of recursive calls to expand defaults to 20\n    *   `options.properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** default properties to evaluate expression against\n\nReturns **[ExpressionExpander](#expressionexpander)** newly created expansion context\n\n## expand\n\nType: [Expander](#expander)\n\n### Parameters\n\n*   `object` \u0026#x20;\n*   `path`   (optional, default `[{value:object}]`)\n\n## properties\n\nProperties used for the default expander implementation\n\n# install\n\nWith [npm](http://npmjs.org) do:\n\n```shell\nnpm install expression-expander\n```\n\n# license\n\nBSD-2-Clause\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farlac77%2Fexpression-expander","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farlac77%2Fexpression-expander","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farlac77%2Fexpression-expander/lists"}