{"analyzedAt":"2022-06-30T22:02:51.370Z","collected":{"metadata":{"name":"lorem-ipsum-filler","scope":"unscoped","version":"1.0.0","description":"A JavaScript module that generates lorem ipsum filler text.","keywords":["lorem","ipsum","filler","text","generator","placeholder"],"date":"2021-09-11T18:26:12.321Z","author":{"name":"Dillon Schultz","email":"dillonschultz93@gmail.com","url":"https://dillonschultz.design","username":"dill_schultz"},"publisher":{"username":"dill_schultz","email":"dillonschultz93@gmail.com"},"maintainers":[{"username":"dill_schultz","email":"dillonschultz93@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/dillonschultz93/lorem-ipsum-generator.git"},"links":{"npm":"https://www.npmjs.com/package/lorem-ipsum-filler","homepage":"https://github.com/dillonschultz93/lorem-ipsum-generator#readme","repository":"https://github.com/dillonschultz93/lorem-ipsum-generator","bugs":"https://github.com/dillonschultz93/lorem-ipsum-generator/issues"},"license":"MIT","devDependencies":{"@types/jest":"^26.0.23","jest":"^27.0.6","prettier":"^2.3.2","ts-jest":"^27.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.3.5"},"releases":[{"from":"2022-05-31T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":0},{"from":"2022-04-01T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":1},{"from":"2022-01-01T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":1},{"from":"2021-06-30T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":3},{"from":"2020-06-30T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":3}],"hasTestScript":true,"hasSelectiveFiles":true,"readme":"# lorem-ipsum-filler\n### A JavaScript module that generates lorem ipsum filler text.\n\n## Installation\n```\nnpm i lorem-ipsum-filler\n```\n\n## Usage\nThere are two ways to use `lorem-ipsum-filler`:\n\n### Class\nThe Class exposes three simple methods to generate filler text.\n\n```\nimport { LoremIpsum } from 'lorem-ipsum-filler';\n\nconst lorem = new LoremIpsum({\n  numberOfSentences: {\n    max: 10,\n    min: 5\n  },\n  numberOfWords: {\n    max: 24,\n    min: 8\n  }\n});\n\nlorem.generateWords(12); // generates 12 words\nlorem.generateSentences(8); // generates 8 sentences\nlorem.generateParagraphs(4); // generates 4 paragraphs\n```\n\n### Function\nThe function takes an object with options passed as it's argument to generate filler text.\n```\nimport { loremIpsum } from 'lorem-ipsum-filler';\n\nconst words = loremIpsum({ count: 12, units: 'words' }); // generates 12 words\nconst sentences = loremIpsum({ count: 8, units: 'sentences' }); // generates 8 sentences\nconst paragraphs = loremIpsum({ count: 4, units: 'paragraphs' }); // generates 4 paragraphs\n```\n\nThese are the options that can be configured and passed to the Function:\n\n```\nloremIpsum({\n  count: 1,                // Number of 'words' | 'sentences' | 'paragraphs'\n  sentenceMinimum: 3,      // Minimum number of sentences in a paragraph\n  sentenceMaximum: 7,      // Maximum number of sentences in a paragraph\n  random: Math.random(),   // A PRNG function\n  wordMinimum: 5,          // Minimum number of words in a sentence\n  wordMaximum: 15,         // Maximum number of words in a sentence\n  units: 'sentences',      // 'words' | 'sentences' | 'paragraphs'\n  words: ['lorem', ...]    // An array of words to pull from\n});\n```\n\n## License\nMIT License\n\nCopyright (c) 2021 Dillon Schultz\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE."},"npm":{"downloads":[{"from":"2022-06-29T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":1},{"from":"2022-06-23T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":3},{"from":"2022-05-31T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":7},{"from":"2022-04-01T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":32},{"from":"2022-01-01T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":58},{"from":"2021-06-30T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":134}],"starsCount":0},"github":{"starsCount":0,"forksCount":0,"subscribersCount":2,"issues":{"count":0,"openCount":0,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"commits":[{"from":"2022-06-23T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":0},{"from":"2022-05-31T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":0},{"from":"2022-04-01T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":0},{"from":"2022-01-01T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":0},{"from":"2021-06-30T00:00:00.000Z","to":"2022-06-30T00:00:00.000Z","count":0}]},"source":{"files":{"readmeSize":2755,"testsSize":9277},"linters":["prettier","tslint"]}},"evaluation":{"quality":{"carefulness":0.9199999999999999,"tests":0.6,"health":1,"branding":0},"popularity":{"communityInterest":2,"downloadsCount":10.666666666666666,"downloadsAcceleration":-0.04467275494672754,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":0.9,"issuesDistribution":0.9}},"score":{"final":0.6089179248323282,"detail":{"quality":0.8364556389013833,"popularity":0.022922689362083776,"maintenance":0.9998808339576686}}}