npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ryniaubenpm/labore-quibusdam-laboriosam

v1.0.0

Published

Lightweight util for generating random sentences, paragraphs and articles in English. Inspired by [Sentencer](https://github.com/kylestetz/Sentencer) and [metaphorpsum.com](http://metaphorpsum.com/).

Downloads

4

Readme

@ryniaubenpm/labore-quibusdam-laboriosam

Lightweight util for generating random sentences, paragraphs and articles in English. Inspired by Sentencer and metaphorpsum.com.

NPM CI test Coverage Status CodeQL

Demo

Setup

Usage

Node.js:

import {
  sentence
} from '@ryniaubenpm/labore-quibusdam-laboriosam'

// with CommonJS environment
// const { sentence } = require('@ryniaubenpm/labore-quibusdam-laboriosam/dist/cjs/@ryniaubenpm/labore-quibusdam-laboriosam.js')

sentence()

Browsers:

Currently, ECMAScript modules work fine on almost all browsers:

<script type="module">
import { sentence } from 'https://unpkg.com/@ryniaubenpm/labore-quibusdam-laboriosam/dist/@ryniaubenpm/labore-quibusdam-laboriosam.esm.js'
console.log(sentence())
</script>

With outdated browsers, we can use the traditional method:

<script type="text/javascript" src="https://unpkg.com/@ryniaubenpm/labore-quibusdam-laboriosam/dist/@ryniaubenpm/labore-quibusdam-laboriosam.min.js"></script>

<script>
console.log(window.@ryniaubenpm/labore-quibusdam-laboriosam.sentence())
</script>

APIs

  • .sentence()
  • .paragraph([Number totalSentences])
  • .article([Number totalParagraphs])
  • .addNouns(Array nouns)
  • .addAdjectives(Array adjectives)
  • .addTemplates(Array sentenceTemplates)
  • .setNouns(Array nouns)
  • .setAdjectives(Array adjectives)
  • .setTemplates(Array sentenceTemplates)
  • .getNouns()
  • .getAdjectives()
  • .getTemplates()
  • .lorem([Number min [, Number max]])

As their name suggests, we have 4 groups of methods:

  • sentence(), paragraph(), article(): generate text by given grammatical unit
  • addNouns(), addAdjectives(), addTemplates(): add more samples to current sample set
  • setNouns(), setAdjectives(), setTemplates(): replace current sample set with new ones
  • getNouns(), getAdjectives(), getTemplates(): get current sample set

The set* and get* methods were added in v2.2.3 to help you customize your sample data.

In addition, we've added lorem() method since v3.0.5 to generate lorem ipsum text.

Template

If you want to add more kinds of sentences, just use the .addTemplates() method; it expects a list of sentence templates. Each sentence template is an English sentence, containing placeholders that can be replaced with any alternative word.

For example:

import {
  addTemplates
} from '@ryniaubenpm/labore-quibusdam-laboriosam'

const templates = [
  '{{a_noun}} is {{a_noun}} from the right perspective',
  'the {{noun}} of {{a_noun}} becomes {{an_adjective}} {{noun}}'
]

addTemplates(templates)

Here are the available placeholders:

  • noun
  • nouns
  • a_noun
  • adjective
  • an_adjective

Lorem ipsum

Syntax:

lorem() // generate a random phrase with length from 2 to 24 words of lorem ipsum
lorem(Number min) // set the minimum number of words
lorem(Number min, Number max)// set the minimum/maximum number of words

Example:

import { lorem } from '@ryniaubenpm/labore-quibusdam-laboriosam'

const phrase = lorem()
console.log(phrase) // => nisi blandit feugiat tempus imperdiet etiam eu mus augue

Test

git clone https://github.com/ryniaubenpm/labore-quibusdam-laboriosam.git
cd @ryniaubenpm/labore-quibusdam-laboriosam
npm install
npm test

License

The MIT License (MIT)