{"_id":"@44north/release-branch-utilities","_rev":"3-fa883c0e38ff4370467d05ca2c76c795","name":"@44north/release-branch-utilities","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@44north/release-branch-utilities","version":"0.1.0","main":"./dist/module.js","types":"./dist/module.d.ts","publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/fortyfournorth/modules.git"},"homepage":"https://github.com/fortyfournorth/modules","bugs":{"url":"https://github.com/fortyfournorth/modules/issues"},"license":"MIT","scripts":{"build":"yarn clean && yarn compile","compile":"tsc -p tsconfig.build.json","clean":"rm -rf ./dist ./coverage","lint":"tslint src/*.ts","test":"jest --coverage","watch":"jest --watch","dev":"jest --watch"},"devDependencies":{"jest":"^26.6.3","jest-extended":"^0.11.5","ts-jest":"^26.4.4","typescript":"^4.1.3"},"gitHead":"a45b351165f62f8d39d95b0a92662768b5df61fd","description":"A Module containing a number of small release-branch-utilities to use in your applications","_id":"@44north/release-branch-utilities@0.1.0","_nodeVersion":"14.15.1","_npmVersion":"lerna/3.22.1/node@v14.15.1+x64 (darwin)","_npmUser":{"name":"cvachon44n","email":"cvachon@fortyfournorth.ca"},"dist":{"integrity":"sha512-TfrEpMmNx+smdaE/ZC2ZRUm4nnSMGuamSigR8QHDMIWTM3kyHMqXWwsvHmsXZqPZKaqVBFC4Uqbkrx2ME9EK/g==","shasum":"007337b58e8fa6a8de52a538a1bfa8f9b7444fee","tarball":"https://registry.npmjs.org/@44north/release-branch-utilities/-/release-branch-utilities-0.1.0.tgz","fileCount":7,"unpackedSize":34487,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDSr0CeOLB5frUvMRO19w4a83F+uTZzrV2PeQR6pYXRsAIhAONmru+/KrxzZrI91cZwcgLRhPdI6O6jW0YT4KDQfIpP"}]},"directories":{},"maintainers":[{"name":"cvachon44n","email":"cvachon@fortyfournorth.ca"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/release-branch-utilities_0.1.0_1635193431934_0.24390475330461792"},"_hasShrinkwrap":false},"0.2.0":{"name":"@44north/release-branch-utilities","version":"0.2.0","main":"./dist/module.js","types":"./dist/module.d.ts","publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/fortyfournorth/modules.git"},"homepage":"https://github.com/fortyfournorth/modules","bugs":{"url":"https://github.com/fortyfournorth/modules/issues"},"license":"MIT","scripts":{"build":"yarn clean && yarn compile","compile":"tsc -p tsconfig.build.json","clean":"rm -rf ./dist ./coverage","lint":"tslint src/*.ts","test":"jest --coverage","watch":"jest --watch","dev":"jest --watch"},"devDependencies":{"jest":"^26.6.3","jest-extended":"^0.11.5","ts-jest":"^26.4.4","typescript":"^4.1.3"},"gitHead":"0191d07cbab2f3cef2026697a8f3d24390d9a224","description":"A Module containing a number of small release-branch-utilities to use in your applications","_id":"@44north/release-branch-utilities@0.2.0","_nodeVersion":"14.17.3","_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (darwin)","_npmUser":{"name":"cvachon44n","email":"cvachon@fortyfournorth.ca"},"dist":{"integrity":"sha512-0NbdORk20QODPTFBV32k8Wc2jaoNU0IKID+aFezkRj2O6LUX9NpZBB+9psmDtzz0KLVjlldYahy9xMYWPrAgzA==","shasum":"b6973b16023ff7fa865374cbdb244f2bdd16c8a2","tarball":"https://registry.npmjs.org/@44north/release-branch-utilities/-/release-branch-utilities-0.2.0.tgz","fileCount":7,"unpackedSize":40207,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhuhjnCRA9TVsSAnZWagAAMXsQAIKQLSxgwEb1P5BD3S31\nVTfHmXVDSoYpnGyxvYnS3ZKqsHoKJrKvTIbBzS8KaiAyTizhnuJYYWCF1swC\nhBB63supELE3UlQBZnKoyNU6+zWIZvtcl9v+cAVtOy26Y5uGaLrRMm1SIxBt\nHdcPd25vRncOvpG9nF+fWbGHAEfxTWW9jpxt0zzNYrqaFSl5ep1Fj1hU1QBn\n2wXNnglEjMMjaRPeTr0BeInhCCG6WFFtJmXKq7MVcmgpN6PQgSz9NeB6hfUG\nG3IVVAqjmCjZh67Kc45bnK1SctQOtEnYjaRhXUoGjbdskfgehfJ53OK6+wiq\nq2GXuBtw0dX3IEH7R7pNZshOENnRbXww/Bf1n56rBnEAcXVXywZlodZ2iWU1\n897J6mzSYjaJZ8yyVbenBFjTjhDJHg1f/tP+bgp2imJEhsCHxH4R69PBbNHU\n9hIT0mH2xKPc9QyhOOeDm1iDyUhfzhiP3RxHGQ65sqe2y8rSDCY47aB9EEwu\nOqkOBm00sD5Oh5tN5EB7o07IIcAefFJPvcwgQAAyM4Rz9tA3unUdL8mEGeyj\n6TOY8hsHoWKNsCrcIM4H28Dfz+h8u/zkoArLgL5MNU+kX3zcsTz1maLnYnQ4\nhdoT85TipYZEkeQpZSd7VG2+F1tIuBHVdRJJkSXzv7/JyyScbZWbs6GW0lsG\nv8pI\r\n=/ntr\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICy7VnT2Dwb8mlngABL8CwvlCiJc/4BIW/gBOG2RJXekAiAxQK0sA0MEynpPhVhs/mbKhPWXVqdPMktNq4yN6bBbzQ=="}]},"directories":{},"maintainers":[{"name":"cvachon44n","email":"cvachon@fortyfournorth.ca"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/release-branch-utilities_0.2.0_1635792425077_0.5528235978242955"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-25T20:23:51.885Z","0.1.0":"2021-10-25T20:23:52.147Z","modified":"2022-04-04T10:45:53.809Z","0.2.0":"2021-11-01T18:47:05.260Z"},"maintainers":[{"name":"cvachon44n","email":"cvachon@fortyfournorth.ca"}],"description":"A Module containing a number of small release-branch-utilities to use in your applications","homepage":"https://github.com/fortyfournorth/modules","repository":{"type":"git","url":"git+https://github.com/fortyfournorth/modules.git"},"bugs":{"url":"https://github.com/fortyfournorth/modules/issues"},"license":"MIT","readme":"# @44north/release-branch-utilities\n\nA Module containing a number of small release-branch-utilities to use in your applications\n\n## Install\n\n```\nnpm install @44north/release-branch-utilities\n```\n\nor\n\n```\nyarn add @44north/release-branch-utilities\n```\n\n## Usage\n\n```ts\nimport { ReleaseBranchUtilities } from \"@44north/release-branch-utilities\";\n\nconst utl = new ReleaseBranchUtilities();\n```\n\n### getDataset\n\nreturns the instance dataset\n\n```ts\nconst utl = new ReleaseBranchUtilities([\"v0.1.0\"]);\nconst data = utl.getDataset();\n\n/* data = [{\n    name: \"v0.1.0\",\n    major: 0,\n    minor: 1,\n    patch: 0\n}];\n*/\n```\n\n### hasEntry\n\nreturns if the dataset has an entry for the provided value\n\n```ts\nconst utl = new ReleaseBranchUtilities([\"v0.1.0\"]);\nutl.hasEntry(\"v0.1.0\"); // true\nutl.hasEntry(\"0.1.0\"); // true\nutl.hasEntry(\"Release-0.1.0\"); // true\nutl.hasEntry(\"0.1.1\"); // false\n```\n\n### addEntry\n\nAdd one or more additional values\n\n```ts\nconst utl = new ReleaseBranchUtilities();\nutl.addEntry(\"v0.1.0\").addEntry([\"v1.0.0\", \"v1.1.0\"]);\nconst data = utl.getDataset();\n\n/* data = [{\n    name: \"v0.1.0\",\n    major: 0,\n    minor: 1,\n    patch: 0\n},{\n    name: \"v1.0.0\",\n    major: 1,\n    minor: 0,\n    patch: 0\n},{\n    name: \"v1.1.0\",\n    major: 1,\n    minor: 1,\n    patch: 0\n}];\n```\n\n### getReleaseName\n\nreturns the release name for a found semvar\n\n```ts\nconst utl = new ReleaseBranchUtilities([\"v0.1.0\"]);\nconst name = utl.getReleaseName(0, 1, 0); // v0.1.0\n```\n\n### getLatestRelease\n\nreturns the release name for a found semvar\n\n```ts\nconst utl = new ReleaseBranchUtilities([\"v0.1.0\", \"v0.2.1\", \"v0.2.0\"]);\nconst name = utl.getLatestRelease(0, 1, 0); // v0.2.1\n```\n\n### next\n\nreturns the release name for a found semvar\n\n```ts\nconst utl = new ReleaseBranchUtilities([\"v0.1.0\", \"v0.2.1\", \"v0.2.0\"]);\nconst major = utl.next(\"major\"); // v1.0.0\nconst minor = utl.next(\"minor\"); // v0.3.0\nconst patch = utl.next(\"patch\"); // v0.2.2\n```\n\n## Static Methods\n\n### is().before()\n\n```ts\nconst result1 = ReleaseBranchUtilities.is(\"Release-v1.0.0\").before(\"Release-v1.1.0\"); // true\nconst result2 = ReleaseBranchUtilities.is(\"Release-v1.0.0\").before(\"Release-v0.1.0\"); // false\n```\n\n### is().after()\n\n```ts\nconst result1 = ReleaseBranchUtilities.is(\"Release-v1.0.0\").after(\"Release-v1.1.0\"); // false\nconst result2 = ReleaseBranchUtilities.is(\"Release-v1.0.0\").after(\"Release-v0.1.0\"); // true\n```\n","readmeFilename":"README.md"}