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

@faykah/core

v0.4.0

Published

Data mock library.

Downloads

21

Readme

@faykah/core

Data mock library.

Code Style Tests Build Package

:paperclip: Summary

:thinking: Requirements

:arrow_down: Installation

Browser

Script

<!DOCTYPE html>
<html>
  <script src="https://unpkg.com/@faykah/core"></script>
  <script>
    "use strict";

    const {createGenerator, createObjectGenerator} = Faykah;
  </script>
</html>

ECMAScript Module

<!DOCTYPE html>
<html>
  <script type="module">
    "use strict";

    import {createGenerator, createObjectGenerator} from "https://unpkg.com/@faykah/core/lib/index.esm.min.js";
  </script>
</html>

Node

$ npm install --save @faykah/core

CommonJS

const {createGenerator, createObjectGenerator} = require("@faykah/core");

ECMAScript Module

import {createGenerator, createObjectGenerator} from "@faykah/core";

:thinking: Usage

Generator

Classic

// Creates a handy function to pick a random first name
const generateFirstName = createGenerator(["Nelson", "Martin", "Muhammad", "Mahatma", "Dalai"]);

// First name randomly picked
const firstName = generateFirstName();

With libraries

import {firstNames} from "@faykah/first-names-en";

// Creates a handy function to pick a random first name
const generateFirstName = createGenerator(firstNames);

// First name randomly picked
const firstName = generateFirstName();

With middleware function

import {firstNames} from "@faykah/first-names-en";

// Creates a handy function to pick a random first name
const generateFirstName = createGenerator(firstNames);

// Return an uppercase version of the text
const uppercased = text => text.toUpperCase();

// First name randomly picked and uppercased
const name = generateName(uppercased);

Object generator

Classic

// Creates a handy function to pick a random user
const generateUser = createObjectGenerator({
  // Pick a random email
  email: ["[email protected]", "[email protected]", "[email protected]"],

  // Pick a random first name
  firstName: ["first", "second", "third"],

  // Pick a random last name
  lastName: ["fourth", "fifth", "sixth"]
});

// User randomly picked
const user = generateUser();

With libraries

import {emails} from "@faykah/emails-en";
import {firstNames} from "@faykah/first-names-en";
import {lastNames} from "@faykah/last-names-en";

// Create a handy function to pick a random user
const generateUser = createObjectGenerator({
  // Pick a random email
  email: emails,

  // Pick a random first name
  firstName: firstNames,

  // Pick a random last name
  lastName: lastNames
});

// User randomly picked
const user = generateUser();

With middleware functions

import {emails} from "@faykah/emails-en";
import {firstNames} from "@faykah/first-names-en";
import {lastNames} from "@faykah/last-names-en";

// Create a handy function to pick a random user
const generateUser = createObjectGenerator({
  // Pick a random email
  email: emails,

  // Pick a random first name
  firstName: firstNames,

  // Pick a random last name
  lastName: lastNames
});

// Handy function to uppercase a text
const uppercased = text => text.toUpperCase();

// Handy function to lowercase a text
const lowercased = text => text.toLowerCase();

// User randomly picked with transformations
const user = generateUser({
  firstName: lowercased,
  lastName: uppercased
});

With nested configuration

import {emails} from "@faykah/emails-en";
import {firstNames} from "@faykah/first-names-en";
import {lastNames} from "@faykah/last-names-en";

// Create a handy function to pick a random user
const generateUser = createObjectGenerator({
  // Pick a random first name
  firstName: firstNames,

  // Pick a random last name
  lastName: lastNames,

  // Meta user informations
  meta: {
    // Pick a random email
    email: emails
  }
});

// Creates a handy function to uppercase a text
const uppercased = text => text.toUpperCase();

// User randomly picked
const user = generateUser({meta: {email: uppercased}});

With multiple generators

import {emails} from "@faykah/emails-en";
import {firstNames} from "@faykah/first-names-en";
import {lastNames} from "@faykah/last-names-en";

// Create a handy function to pick a random user
const generateUserName = createObjectGenerator({
  // Pick a random first name
  firstName: firstNames,

  // Pick a random last name
  lastName: lastNames
});

// Creates a handy function for generating user informations
const generateUserInformations = createObjectGenerator({
  // Pick a random email
  email: emails
});

// User randomly picked
const user = {
  ...generateUserName(),
  ...generateUserInformations()
};

:bookmark: Changelog

See CHANGELOG.md

:pray: Contributing

See CONTRIBUTING.md

:scroll: License

See LICENSE