{"id":16763969,"url":"https://github.com/vitalics/dotenv-guards","last_synced_at":"2025-03-16T11:11:41.242Z","repository":{"id":37005464,"uuid":"501599535","full_name":"vitalics/dotenv-guards","owner":"vitalics","description":"guards functions for dotenv package","archived":false,"fork":false,"pushed_at":"2023-12-15T20:30:32.000Z","size":103,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-24T23:17:37.748Z","etag":null,"topics":["dotenv","dotenv-cli"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/dotenv-guards","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/vitalics.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":"2022-06-09T10:05:22.000Z","updated_at":"2022-06-09T14:04:41.000Z","dependencies_parsed_at":"2023-01-17T12:38:07.673Z","dependency_job_id":null,"html_url":"https://github.com/vitalics/dotenv-guards","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalics%2Fdotenv-guards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalics%2Fdotenv-guards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalics%2Fdotenv-guards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitalics%2Fdotenv-guards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitalics","download_url":"https://codeload.github.com/vitalics/dotenv-guards/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858039,"owners_count":20359269,"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":["dotenv","dotenv-cli"],"created_at":"2024-10-13T05:24:05.654Z","updated_at":"2025-03-16T11:11:41.218Z","avatar_url":"https://github.com/vitalics.png","language":"TypeScript","readme":"# dotenv guards\n\n![dotenv-guards](images/logo.png)\n\n![release status](https://github.com/vitalics/dotenv-guards/actions/workflows/release.yaml/badge.svg)\n\n![tests status](https://github.com/vitalics/dotenv-guards/actions/workflows/pr.yaml/badge.svg)\n\nguards functions for dotenv package\n\n## installation\n\n```bash\nnpm i dotenv dotenv-guards\n```\n\n## usage\n\n```js\nimport { numberGuard } from 'dotenv-guards';\n\nconst jobsAsNumber = numberGuard(process.env.jobs, 2); // return 2 if jobs is not a number\n```\n\n## Available guards\n\n- `numberGuard` - parse a string to a number.\n- `enumGuard` - parse a string to an enum.\n- `booleanGuard` - parse a string to a boolean.\n- `arrayGuard` - parse a string to an array.\n- `string` - parse string and execute matchers.\n\n## Custom guards\n\nIn case if you want to define custom guards - you can use `define` and `revoke` functions.\n\nExample:\n\n``` ts\nimport { define, revoke } from 'dotenv-guards';\n\n// define new guard\nconst jsonGuard = define((val: string | undefined) =\u003e {\n    return JSON.parse(val);\n});\n\njsonGuard('{\"qwe\": true}'); // returns { qwe: true }\n\nrevoke(jsonGuard); // remove json guard\n\njsonGuard('{\"qwe\": true}'); // TypeError. jsonGuard is revoked\n```\n\n## API\n\n### number guard\n\n```javascript\nnumberGuard(value, fallbackValue, options)\n```\n\n### Parameters\n\n- `value` - [`string`] - string-like variable.\n- `options` - [`Object`]\n  - `throwOnFinite` - [`boolean`] - Throws an error if incoming value parsed to `Infinity`. Default is `false`.\n  - `throwOnNaN` - [`boolean`] - Throws an error if incoming value parsed to `NaN`. Default is `false`.\n  - `throwOnUndefined` - [`boolean`] - If `true` throwing an error if incoming value is undefined. Default is `false`.\n  - `throwOnSafeInteger` - [`boolean`] - Throws an error if incoming value is not safe integer. Default is `false`.\n\n#### Returns\n\n`number`\n\nExample:\n\n```js\n// process.env.jobs = '2'\nnumberGuard(process.env.jobs); // returns 2 as number\n\n// process.env.jobs = 'not a number string'\nnumberGuard(process.env.jobs); // returns 0 as number\n\n// process.env.jobs = 'not a number string'\nnumberGuard(process.env.jobs, 0, {throwOnSafeInteger: true}); //throws an error\n```\n\n### boolean guard\n\n```javascript\nbooleanGuard(value, options)\n```\n\n#### Parameters\n\n- value - [`string`] - string-like variable.\n- `options` - [`Object`]\n  - `fallback` - fallback value if incoming value is not a boolean and cannot parse value to boolean.\n  - `trueSymbols` - [`string`] - Array of possible values which will be converted as `true`. Default is `['1', 'true']`\n  - `throwOnUndefined` Throw an error if incoming value is undefined, fallback value is not returned, since it returns an error. Default is `false`.\n  - `throwOnFail` - Throw an error if incoming value is not matching with `trueSymbols` option. Default is `false`.\n\n#### Returns\n\n`boolean`\n\nExample:\n\n```javascript\n// process.env.isDebug = 'true'\nbooleanGuard(process.env.isDebug); // returns true\n\n// process.env.acceptDownloading = 'yes'\nbooleanGuard(process.env.acceptDownloading, false, {trueSymbols: ['yes']}); // returns true since 'yes' is in the array\n```\n\n### enum guard\n\n```javascript\nenum(value, arrayOfPossibleValues, fallbackValue)\n```\n\n### Parameters\n\n- `value` - [`string`] - string-like variable.\n- `arrayOfPossibleValues` - [`Array\u003cstring\u003e`] - Array of possible values.\n- `fallbackValue` - [`string`] - fallback value.\n\n#### Returns\n\n`string`\n\nExample:\n\n``` javascript\n// process.env.NODE_ENV = 'test'\nenumGuard(process.env.NODE_ENV, ['development', 'production'], 'development'); // returns 'development'\n\n// or define more acceptable values\n// process.env.NODE_ENV = 'test'\nenumGuard(process.env.NODE_ENV, ['development', 'production', 'test'], 'development'); // returns 'test', since 'test' is in the array\n```\n\n### array guard\n\n```javascript\narray(value, arrayOfPossibleValues, options)\n```\n\n#### Parameters\n\n- `value` - [`string`] - string-like variable.\n- `arrayOfPossibleValues` - [`Array\u003cstring\u003e`] - If `true` throwing an error if at least one element is not matched.\n- `options` - [`Object`]\n  - `strict` - [`boolean`] - If `true` throwing an error if at least one element is not matched. Default is `false`.\n  - `separator` - [`string`] - Parsing separator. Default is `,`\n\n#### Returns\n\n`string`\n\nExample:\n\n```javascript\n// process.env.array = 'val1,val2,val3'\narrayGuard(process.env.array, ['val1', 'val2']); // split string by `,` symbol and returns ['val1', 'val2']\n\n// custom separator\n// process.env.array = 'val1;val2;val3'\narrayGuard(process.env.array, ['val1', 'val2', 'val3'], {separator: ';'}); // split string by `;` symbol and returns ['val1', 'val2', 'val3']\n```\n\n### string guard\n\n```javascript\nstring(value, options)\n```\n\n#### Parameters\n\n- `value` - [string]. Parsing string-like value.\n- `options`\n  - `fallback`- [string] - fallback value if incoming value is not matched by regex or matcher function.\n  - `throwOnUndefined`- [boolean] - Throw an error if incoming value is undefined, fallback value is not returned, since it returns an error.\n  - `regexp`- [RegExp] - Regexp for incoming value. Returns first match.\n  - `throwOnNullable` - [boolean] - Throw an error if incoming value is null, undefined, empty string or empty array.\n  - `matcher` - [boolean] - Matcher function for incoming value. Returns boolean(is matched incoming string or not).\n  - `throwOnMismatch` - [boolean] - Throw an error if incoming value is not matched by regex or matcher function.\n\n#### Returns\n\n`string`\n\nExample:\n\n```javascript\n// process.env.token = 'hash123'\nstringGuard(process.env.token); // returns hash123\n\n// matcher function\n// process.env.token = 'hash123'\narrayGuard(process.env.token, {\n    matcher: (value) =\u003e value.startsWith('hash'),\n}); // returns hash123\n\n// miss matching\n// process.env.token = 'hash123'\narrayGuard(process.env.token, {\n    matcher: (value) =\u003e value.startsWith('random string'),\n    fallback: 'qwerty'\n}); // returns qwerty, since mismatch\n```\n\n### define(fn)\n\n#### Parameters\n\n- `function` - [Function] - First argument should accepts type `string | undefined`, otherwise it throws an `TypeError`\n\n#### returns\n\nFunction\n\n### revoke(fn)\n\n#### Parameters\n\n- `function` - [Function] - function reference from `define`. It will throw a `ReferenceError` in case of function is not created from `define`.\n\n#### Returns\n\nvoid\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitalics%2Fdotenv-guards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitalics%2Fdotenv-guards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitalics%2Fdotenv-guards/lists"}