{"id":15171740,"url":"https://github.com/zardoy/vk-params","last_synced_at":"2026-01-24T22:06:14.597Z","repository":{"id":51862827,"uuid":"299319422","full_name":"zardoy/vk-params","owner":"zardoy","description":"A small helper for working with VK launch params","archived":false,"fork":false,"pushed_at":"2021-05-09T11:15:16.000Z","size":169,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-03T06:38:45.793Z","etag":null,"topics":["launch-params","library","module","typescript","vk","vk-mini-apps","vkontakte"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/@zardoy/vk-params","language":"TypeScript","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/zardoy.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":"2020-09-28T13:35:32.000Z","updated_at":"2022-02-06T18:40:51.000Z","dependencies_parsed_at":"2022-08-27T13:11:43.510Z","dependency_job_id":null,"html_url":"https://github.com/zardoy/vk-params","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/zardoy/vk-params","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zardoy%2Fvk-params","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zardoy%2Fvk-params/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zardoy%2Fvk-params/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zardoy%2Fvk-params/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zardoy","download_url":"https://codeload.github.com/zardoy/vk-params/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zardoy%2Fvk-params/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28737935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T21:19:41.845Z","status":"ssl_error","status_checked_at":"2026-01-24T21:13:38.675Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["launch-params","library","module","typescript","vk","vk-mini-apps","vkontakte"],"created_at":"2024-09-27T09:03:05.046Z","updated_at":"2026-01-24T22:06:14.581Z","avatar_url":"https://github.com/zardoy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VK Params \u0026middot; [![npm version](https://img.shields.io/npm/v/@zardoy/vk-params?color=limegreen)](https://npmjs.com/package/@zardoy/vk-params) [![GitHub top language](https://img.shields.io/github/languages/top/zardoy/vk-params)](https://github.com/zardoy/vk-params/tree/master/src) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\nA small helper for working with VK [launch params [ru]](https://vk.com/dev/vk_apps_docs3?f=6.%2B%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B%2B%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA%D0%B0). Useful for **vk-mini-apps**.\n\n## Usage\n\n```ts\nimport { vkGetParam } from \"@zardoy/vk-params\";\n\n// No vk_ prefix needed\nvkGetParam(\"app_id\");\n//=\u003e 6739175\n\nvkGetParam(\"are_notifications_enabled\");\n//=\u003e false\n```\n\n## API\n\n### `vkGetParam(param)`\n\n- param: name of param to get. Use without *_vk* prefix. [A full list of params [ru]](https://vk.com/dev/vk_apps_docs3?f=6.%2B%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B%2B%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA%D0%B0).\n\nReturn value depends on param argument.\n\nIt is important to know, that if appropriate param in url doesn't exist this function will [throw an Error](https://github.com/zardoy/vk-params/blob/b73581e07f2fe11771fdc6ceb4d6b087a3451aff/src/index.ts#L29).\n\n### `vkIsDesktopVersion(): boolean`\n\nShortcut for `vkGetParam(\"platform\") === \"desktop_web\"`.\n\n### `paramNames`\n\nArray of names all VK launch params.\n\n### `nullableParamNames`\n\nSame as previous, but contains only params that may not exist in url.\n\n## Things to note\n\n- If you are using *React*, you should use [Error Boundary](https://ru.reactjs.org/docs/error-boundaries.html) in the root of your app.\n- For proper typings support, use TypeScript v4 or higher.\n\n[Stats, file list and more package details](https://yarnpkg.com/package/@zardoy/vk-params)\n\n*Please*, let me know if you find a better alternative to this module.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzardoy%2Fvk-params","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzardoy%2Fvk-params","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzardoy%2Fvk-params/lists"}