{"_id":"@37bytes/environment-info","_rev":"3-07d8ad2ce5d2f02f7c641c5c946865f3","name":"@37bytes/environment-info","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@37bytes/environment-info","version":"1.0.0","description":"A set of utilities to enhance work with internal environments.","repository":{"type":"git","url":"git+https://github.com/37bytes/public-packages.git#master"},"main":"./build/index.js","scripts":{"build":"rimraf build && tsc --project ./tsconfig.json","build&watch":"rimraf build && tsc --project ./tsconfig.json --watch","npm-packlist":"npm run build && npx -y npm-packlist@6.0.1"},"keywords":[],"author":{"name":"@37bytes"},"license":"MIT","devDependencies":{"rimraf":"3.0.2","typescript":"^4.6.4"},"gitHead":"b89e3eba83dce8dc591524532f80e3d0b4de81ae","bugs":{"url":"https://github.com/37bytes/public-packages/issues"},"homepage":"https://github.com/37bytes/public-packages/tree/master#readme","_id":"@37bytes/environment-info@1.0.0","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-2T3ggBtNH/DCeyLNjd+mbPBpnaIyUfs/11/JQVDO8B2lNEyfuJ/VvLa0L3g7Y9O6slFhAV+tksLK0f5HhFpHjg==","shasum":"69647d59026ee1bb69c74ef681cdc8f63c6edfe2","tarball":"https://registry.npmjs.org/@37bytes/environment-info/-/environment-info-1.0.0.tgz","fileCount":4,"unpackedSize":4890,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCbMUyCE+Lc+Q/r2oO87YlS1QWlage2/19izM9jk3DScAIhAJbqRT992oQ4U1xXTV63ChofuRw9UEa3GMJUXMB6A58n"}]},"_npmUser":{"name":"tnikolaeva","email":"tnikolaeva@37bytes.com"},"directories":{},"maintainers":[{"name":"rispaev","email":"rispaev@37bytes.com"},{"name":"yar_vav","email":"yavavilin@37bytes.com"},{"name":"rteslenko","email":"rteslenko@37bytes.com"},{"name":"tnikolaeva","email":"tnikolaeva@37bytes.com"},{"name":"dc.nikolaev","email":"dnikolaev@37bytes.com"},{"name":"mgarmash","email":"ops@37bytes.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/environment-info_1.0.0_1695731269423_0.6077238848714557"},"_hasShrinkwrap":false},"1.0.1":{"name":"@37bytes/environment-info","version":"1.0.1","description":"A set of utilities to enhance work with internal environments.","repository":{"type":"git","url":"git+https://github.com/37bytes/public-packages.git#master"},"main":"./build/index.js","scripts":{"build":"rimraf build && tsc --project ./tsconfig.json","build&watch":"rimraf build && tsc --project ./tsconfig.json --watch","npm-packlist":"npm run build && npx -y npm-packlist@6.0.1"},"keywords":[],"author":{"name":"@37bytes"},"license":"MIT","devDependencies":{"rimraf":"3.0.2","typescript":"^4.6.4"},"types":"./build/index.d.ts","gitHead":"b89e3eba83dce8dc591524532f80e3d0b4de81ae","bugs":{"url":"https://github.com/37bytes/public-packages/issues"},"homepage":"https://github.com/37bytes/public-packages/tree/master#readme","_id":"@37bytes/environment-info@1.0.1","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-P/V7jIGnmBXSiY6YY4tkMSO2B/AftIxiO4pHiIABqM3QpshJL77c/k7S+SxgcM8ZnwKehqf2OUObrlkSA+3D6A==","shasum":"cfd7e187961eb875eaf209899b3fbfbe93ed67ae","tarball":"https://registry.npmjs.org/@37bytes/environment-info/-/environment-info-1.0.1.tgz","fileCount":10,"unpackedSize":6577,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDV/7Wh1I+kOykS72GdGVV9yZ+iLEokp31usRw8b72+qwIgR1/5Cj41QoALz86RC6Ur90nSUzFwP+E+Lx+KCfyNNb0="}]},"_npmUser":{"name":"tnikolaeva","email":"tnikolaeva@37bytes.com"},"directories":{},"maintainers":[{"name":"rispaev","email":"rispaev@37bytes.com"},{"name":"yar_vav","email":"yavavilin@37bytes.com"},{"name":"rteslenko","email":"rteslenko@37bytes.com"},{"name":"tnikolaeva","email":"tnikolaeva@37bytes.com"},{"name":"dc.nikolaev","email":"dnikolaev@37bytes.com"},{"name":"mgarmash","email":"ops@37bytes.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/environment-info_1.0.1_1695732101170_0.046458578024838104"},"_hasShrinkwrap":false},"1.0.2":{"name":"@37bytes/environment-info","version":"1.0.2","description":"A set of utilities to enhance work with internal environments.","repository":{"type":"git","url":"git+https://github.com/37bytes/public-packages.git#master"},"main":"./build/index.js","scripts":{"build":"rimraf build && tsc --project ./tsconfig.json","build&watch":"rimraf build && tsc --project ./tsconfig.json --watch","npm-packlist":"npm run build && npx -y npm-packlist@6.0.1"},"keywords":[],"author":{"name":"@37bytes"},"license":"MIT","devDependencies":{"rimraf":"3.0.2","typescript":"^4.6.4"},"types":"./build/index.d.ts","gitHead":"b89e3eba83dce8dc591524532f80e3d0b4de81ae","bugs":{"url":"https://github.com/37bytes/public-packages/issues"},"homepage":"https://github.com/37bytes/public-packages/tree/master#readme","_id":"@37bytes/environment-info@1.0.2","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-Pa5H9DDv8pHXvtlydLYI5xDAzWEh2d5XxiSi6JQQCDhzbIqcygJzkOrX1UyNKlG1mw0Ki7I9x6juaaKVJmr6Cw==","shasum":"2174fa3261b4bdbc0ad8d76dc7b20fb253ff572b","tarball":"https://registry.npmjs.org/@37bytes/environment-info/-/environment-info-1.0.2.tgz","fileCount":10,"unpackedSize":6621,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBilvnDWw1kULt9ts5VEd8bUUHb3xI4qsgHZSvuB3ZRiAiEAiTyQMhU3vCw+JImjBoWmpXG7w9KHo8F5xePzOGfZfv0="}]},"_npmUser":{"name":"tnikolaeva","email":"tnikolaeva@37bytes.com"},"directories":{},"maintainers":[{"name":"rispaev","email":"rispaev@37bytes.com"},{"name":"yar_vav","email":"yavavilin@37bytes.com"},{"name":"rteslenko","email":"rteslenko@37bytes.com"},{"name":"tnikolaeva","email":"tnikolaeva@37bytes.com"},{"name":"dc.nikolaev","email":"dnikolaev@37bytes.com"},{"name":"mgarmash","email":"ops@37bytes.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/environment-info_1.0.2_1695732347468_0.0675316009206055"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-26T12:27:49.277Z","1.0.0":"2023-09-26T12:27:49.562Z","modified":"2023-12-21T13:06:48.765Z","1.0.1":"2023-09-26T12:41:41.377Z","1.0.2":"2023-09-26T12:45:47.670Z"},"maintainers":[{"email":"naushev@37bytes.com","name":"arhonist-37b"},{"email":"rispaev@37bytes.com","name":"rispaev"},{"email":"yavavilin@37bytes.com","name":"yar_vav"},{"email":"rteslenko@37bytes.com","name":"rteslenko"},{"email":"tnikolaeva@37bytes.com","name":"tnikolaeva"},{"email":"dnikolaev@37bytes.com","name":"dc.nikolaev"},{"email":"ops@37bytes.com","name":"mgarmash"}],"description":"A set of utilities to enhance work with internal environments.","homepage":"https://github.com/37bytes/public-packages/tree/master#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/37bytes/public-packages.git#master"},"author":{"name":"@37bytes"},"bugs":{"url":"https://github.com/37bytes/public-packages/issues"},"license":"MIT","readme":"### About \r\n\r\nA set of utilities to enhance work with internal environments.\r\n\r\n### Installation\r\n\r\nRun the following command to install the package:\r\n\r\n```sh\r\nnpm install @37bytes/environment-info\r\n```\r\n\r\n### Description\r\n\r\n#### getEnvironmentInfo\r\nA utility for retrieving information about the current application version and the current environment. When called, it returns a string.\r\n\r\nIt takes an object with the following fields as input:\r\n\r\n| Params       |  Type   | Required  |                          Description |\r\n|--------------|:-------:|:---------:|-------------------------------------:|\r\n| stand        | string  |     +     |                           Stand name |\r\n| version      | string  |     -     |          Current Application Version |\r\n| commitHash   | string  |     -     |                       Current Commit |\r\n| branch       | string  |     -     |                       Current Branch |\r\n| isProduction | boolean |     -     |     Production Environment Indicator |\r\n\r\nIf ``isProduction = true``, the response will be in the form of:\r\n``${version}``,\r\notherwise, the utility will return a string in the form of:\r\n``${version}|${stand}; ${branch}#${commitHash}``\r\n\r\n**Important**: When determining whether it's a production environment, we use a list of internal environments, not a list of production environments.\r\n\r\n```javascript\r\nconst isProductionEnvironment = (envName: string) => {\r\n    if (import.meta.env.DEV) {\r\n        return false;\r\n    }\r\n    \r\n    if (['test', 'stage'].includes(envName)) {\r\n        return false;\r\n    }\r\n    \r\n    return true;\r\n}\r\n```\r\n\r\n#### startEnvironmentTitleWatcher\r\nA utility for adding the stand name to the title of the browser tab. \r\nIt takes one argument: ``standName: string``\r\n\r\n\r\n###Version History\r\n\r\n1.0.2\r\n- readme updated\r\n\r\n1.0.1\r\n- Initial release.\r\n","readmeFilename":"README.md"}