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

chance-path-object

v1.0.1

Published

A Chance.js mixin to generate path objects.

Downloads

5

Readme

chance-path-object Build Status

A Chance.js mixin to generate path objects.

Path objects are what Node uses for input to path.format and for output from path.parse.

Install

NPM

$ npm i chance-path-object

Yarn

$ yarn add chance-path-object

Usage

import Chance from 'chance';
import pathObject from 'chance-path-object';

const chance = new Chance();

chance.mixin({
    pathObject
});

chance.pathObject();

By default, chance-path-object will return an path object with keys, but no values.

Example:

{
    base: '',
    dir: '',
    ext: '',
    name: '',
    root: ''
}

Options

Below is a list of available configuration options that you can pass into chance-path-object.

chance.pathObject({
    // options
});

The options are designed to be explicitly inclusive and used together in order to generate a desired path object output.

Example:

chance.pathObject({
    base: true,
    ext: true,
    name: true
});

Result:

{
    base: 'some-name.some-ext',
    dir: '',
    ext: '.some-ext',
    name: 'some-name',
    root: ''
}

root

Specifies if the path object should contain a root property.

For example, chance.pathObject({root: true}) would produce:

{
    base: '',
    dir: '',
    ext: '',
    name: '',
    root: '/'
}

Defaults to false.

dir

Specifies if the path object should contain a dir property.

For example, chance.pathObject({dir: true}) would produce:

{
    base: '',
    dir: 'some/random/path',
    ext: '',
    name: '',
    root: ''
}

If root is also provided, it will prepend root to the dir as well.

For example, chance.pathObject({root: true, dir: true}) would produce:

{
    base: '',
    dir: '/some/random/path',
    ext: '',
    name: '',
    root: '/'
}

Defaults to false.

relative

This is used in conjunction with the dir option.

Specifies if the path object should contain a relative dir path.

For example, chance.pathObject({dir: true, relative: true}) would produce:

{
    base: '',
    dir: '../some/random/path',
    ext: '',
    name: '',
    root: ''
}

Defaults to false.

name

Specifies if the path object should contain a name property.

For example, chance.pathObject({name: true}) would produce:

{
    base: '',
    dir: '',
    ext: '',
    name: 'some-random-name',
    root: ''
}

Defaults to false.

dotfile

This is used in conjunction with the name option.

Specifies if the path object should contain a dotfile for a name.

For example, chance.pathObject({name: true, dotfile: true}) would produce:

{
    base: '',
    dir: '',
    ext: '',
    name: '.some-dotfile',
    root: ''
}

Defaults to false.

ext

Specifies if the path object should contain an ext property.

For example, chance.pathObject({ext: true}) would produce:

{
    base: '',
    dir: '',
    ext: '.some-ext',
    name: '',
    root: ''
}

Defaults to false.

base

Specifies if the path object should contain a base property.

For example, chance.pathObject({base: true}) would produce:

{
    base: 'some-name.some-ext',
    dir: '',
    ext: '',
    name: '',
    root: ''
}

However, if the name or ext options above are used, their values will be used to construct the base property.

Defaults to false.

License

MIT © Michael Novotny