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

fallguys-names

v2.1.1

Published

Fully customizable what-three-words generator with a default set of fallguys names.

Downloads

10

Readme

Fall Guys names

Fully customizable what-three-words generator with a default set of fallguys names.

export type WordModifiers = {
  firsts?: string[]
  seconds?: string[]
  thirds?: string[]
}

export type FGConfig = {
  quantity?: number
  mix?: WordModifiers
  replace?: WordModifiers
  separator?: string
}

function fallguys(args: FGConfig): string | string[]

How to

# Install the package as a dependency
$ yarn add fallguys-names
// In your project, import from 'fallguys-names'
import fallguys, { FGConfig } from 'fallguys-names'

// fallguys-names exports a default function that generates a random what-three-words style string
const myAwesomeNewFallGuysName: string = fallguys() // e.g. "Clever Streaming Knight"

const config: FGConfig = {
  quantity: 2,
}

const myArrayOfNames: string[] = fallguys(config) // e.g. ["Steady Yeeted Climber", "Bonkers Bumbling Monster"]

Configuration options

Optionally you can pass an object as an argument, with any of the following fields:

| field | type | required | default | | :-------- | :----- | :------- | :------------- | | quantity | number | false | 1 | | mix | Object | false | undefined | | replace | Object | false | undefined | | separator | string | false | a single space |

quantity

The quantity or strings that the function will return. Important! by increasing the quantity to more than one, the function will return an array of names

mix

You may supply your own choice of words to mix with the original words in the library.

replace

You may supply your own choice of words to replace the original words in the library.

separator

The separator character to be used between the words. Defaults to a single space.

fallguys