{"id":15387174,"url":"https://github.com/wildhoney/paramo","last_synced_at":"2026-02-17T16:37:07.228Z","repository":{"id":35140389,"uuid":"211952261","full_name":"Wildhoney/Paramo","owner":"Wildhoney","description":"🌵Swiss-army knife of stringifying, parsing and manipulating URL parameters by applying types to the parameters.","archived":false,"fork":false,"pushed_at":"2023-01-06T02:11:05.000Z","size":1596,"stargazers_count":0,"open_issues_count":15,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-05T00:53:24.300Z","etag":null,"topics":["query-parameter-set","query-parameters","query-params","query-params-parsing","query-parser","query-string","query-string-builder","query-stringifier","queryparams","searchparams","url-parameters","urlsearchparams"],"latest_commit_sha":null,"homepage":"","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/Wildhoney.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":"2019-09-30T20:38:30.000Z","updated_at":"2023-09-08T17:58:33.000Z","dependencies_parsed_at":"2023-01-15T14:38:25.572Z","dependency_job_id":null,"html_url":"https://github.com/Wildhoney/Paramo","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/Wildhoney/Paramo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FParamo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FParamo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FParamo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FParamo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Wildhoney","download_url":"https://codeload.github.com/Wildhoney/Paramo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Wildhoney%2FParamo/sbom","scorecard":{"id":151298,"data":{"date":"2025-08-11","repo":{"name":"github.com/Wildhoney/Paramo","commit":"eb18a21a715fe1be6a5fe1dbc50523c90d687871"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"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":"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":"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":"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":"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":"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":"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":"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":"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":"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"}},{"name":"Vulnerabilities","score":0,"reason":"35 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-px4h-xg32-q955","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T10:45:00.379Z","repository_id":35140389,"created_at":"2025-08-16T10:45:00.380Z","updated_at":"2025-08-16T10:45:00.380Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279014168,"owners_count":26085369,"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-13T02:00:06.723Z","response_time":61,"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":["query-parameter-set","query-parameters","query-params","query-params-parsing","query-parser","query-string","query-string-builder","query-stringifier","queryparams","searchparams","url-parameters","urlsearchparams"],"created_at":"2024-10-01T14:52:23.100Z","updated_at":"2025-10-13T03:09:08.925Z","avatar_url":"https://github.com/Wildhoney.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"media/logo.png\" alt=\"Paramo\" width=\"300\" /\u003e\n\n\u003e Swiss-army knife of stringifying, parsing and manipulating URL parameters by applying types to the parameters.\n\n![Travis](http://img.shields.io/travis/Wildhoney/Paramo.svg?style=for-the-badge)\n\u0026nbsp;\n![npm](http://img.shields.io/npm/v/paramo.svg?style=for-the-badge)\n\u0026nbsp;\n![License MIT](http://img.shields.io/badge/license-mit-lightgrey.svg?style=for-the-badge)\n\u0026nbsp;\n![Coveralls](https://img.shields.io/coveralls/Wildhoney/Paramo.svg?style=for-the-badge)\n\u0026nbsp;\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)\n\n**npm**: `npm install paramo`\n\n**yarn**: `yarn add paramo`\n\n---\n\n## Getting Started\n\n`Paramo` takes the very useful [query-string]() library and applies the concept of types as an added layer. Although `query-string` provides some typecasting of values, it's far from ideal. Using the example below we can setup a type system to transform URL parameters back and forth between string representations.\n\n```javascript\nimport { create, type } from 'paramo';\n\nconst types = {\n    name: type.String,\n    age: type.Int,\n};\n\nconst user = create(types);\n\n// { name: 'Adam', age: 34 }\nuser.parse('name=Adam\u0026age=34');\n\n// name=Adam\u0026age=34\nuser.stringify({ name: 'Adam', age: 34 });\n```\n\nThe `String` and `Int` types are probably the most simple types. Using the `Bool` type takes a little more configuration if the default isn't sufficient, as booleans can be represented as strings in many various ways. With that in mind, you can provide a second argument to the `create` function which overrides the defaults \u0026ndash; in our case to modify the string representations of boolean values to be the pirate-esque `yar` and `naw`.\n\n```javascript\nimport { create, type } from 'paramo';\n\nconst types = {\n    name: type.String,\n    age: type.Int,\n    developer: type.Bool,\n};\n\nconst user = create(types, {\n    booleanStrings: ['yar', 'naw'],\n});\n\n// { name: 'Adam', age, 34: developer: true }\nuser.parse('name=Adam\u0026age=34\u0026developer=yar');\n\n// name=Adam\u0026age=34\u0026developer=yar\nuser.stringify({ name: 'Adam', age: 34, developer: true });\n```\n\nWe can then introduce the concept of arrays which uses [the `query-string` API](https://github.com/sindresorhus/query-string#api) for specifying how lists are represented \u0026ndash; by default as duplicate keys.\n\n```javascript\nimport { create, type, option } from 'paramo';\n\nconst types = {\n    name: type.String,\n    age: type.Int,\n    developer: type.Bool,\n    languages: type.Array(type.String),\n};\n\nconst user = create(types, {\n    booleanStrings: ['yar', 'naw'],\n    arrayFormat: option.arrayFormat.comma,\n});\n\n// { name: 'Adam', age, 34: developer: true, languages: ['JavaScript', 'Ruby', 'Haskell'] }\nuser.parse('name=Adam\u0026age=34\u0026developer=yar\u0026languages=JavaScript,Ruby,Haskell');\n\n// name=Adam\u0026age=34\u0026developer=yar\u0026languages=JavaScript,Ruby,Haskell\nuser.stringify({\n    name: 'Adam',\n    age: 34,\n    developer: true,\n    languages: ['Javascript', 'Ruby', 'Haskell'],\n});\n```\n\n## Default Values\n\nYou can set defaults for the parameters by using the array notation. For example if by default all users are developers, then you can bake that into your types.\n\n```javascript\nconst types = {\n    name: type.String,\n    age: type.Int,\n    developer: [type.Bool, true],\n    languages: type.Array(type.String),\n};\n```\n\nWhen you `user.stringify` all parameters are still set, but in some cases you may wish for the default values to be omitted, as the default values may not matter if they are also baked into the back-end. For these instances you can set the `stripDefaults` option when creating the type instance.\n\n```javascript\nconst user = create(types, {\n    booleanStrings: ['yar', 'naw'],\n    stripDefaults: true,\n});\n```\n\nFurthermore when dealing with defaults you may wish for defaults to appear in `user.parse` unless they're defined in the URL parameters \u0026ndash; you can use the `includeDefaults` option. You can use the same option for `user.stringify` if you don't set the aforementioned `stripDefaults` option.\n\n## Configurable Options\n\n| Option                 | Default             | Description                                                                                                                  |\n| ---------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| `includeDefaults`      | `false`             | Include default values when parsing.                                                                                         |\n| `stripDefaults`        | `false`             | Include default values when stringifying.                                                                                    |\n| `stripRedundant`       | `false`             | Exclude parameters which are not included in the types.                                                                      |\n| `booleanStrings`       | `['true', 'false']` | Tuple of custom boolean types: `['yup', 'nup']`.                                                                             |\n| `arrayFormat`          | `null`              | [`query-string`](https://github.com/sindresorhus/query-string) option for representing arrays as strings.                    |\n| `arrayFormatSeparator` | `,`                 | [`query-string`](https://github.com/sindresorhus/query-string) option for setting a custom separator.                        |\n| `dateFormat`           | `YYYY-MM-DD`        | [`moment`](https://momentjs.com/docs/) formatting for dates.                                                                 |\n| `keyFormat`            | `null`              | Applying snakecase, kebabcase and pascalcase to the parameters.                                                              |\n| `splitKeys`            | `null`              | Allows the [custom splitting of keys](https://github.com/domchristie/humps#humpsdecamelizestring-options) when decamelising. |\n| `processKeys`          | `null`              | Allows the setting up of a [key processing function](https://github.com/domchristie/humps#converting-object-keys).           |\n| `stripPrefix`          | `false`             | Whether to include the question mark when stringifying params.                                                               |\n| `encodeParams`         | `true`              | Determines whether keys and values are encoded.                                                                              |\n| `decodeParams`         | `true`              | Determines whether keys and values are decoded.                                                                              |\n| `sortParams`           | `false`             | Function for sorting the params when stringifying.                                                                           |\n| `plainObject`          | `false`             | Force the parsed object to return a plain object.                                                                            |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwildhoney%2Fparamo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwildhoney%2Fparamo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwildhoney%2Fparamo/lists"}