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

@microsoft/fast-permutator

v2.3.0

Published

Creates all possible permutations of a component based on its JSON Schema.

Downloads

58

Readme

FAST Permutator

FAST Permutator has been deprecated. Use FAST Tooling React instead.

The FAST permutator creates all possible data permutations from a given JSON Schema, allowing for deep testing or display of complex data sets.

Use

Including the permutator

Add the permutator as a required variable:

const permutator = require('@microsoft/fast-permutator');

Permutating data sets

The main export of the permutator is to recieve a schema and any schema references. For example, take this simple schema:

let schema = {
    type: "object",
    properties: {
        stringItem: {
            type: "string",
            example: "Hello World"
        },
        booleanItem: {
            type: "boolean"
        }
    },
    required: [
        "stringItem"
    ]
};

permutator(schema);

This main export permutator will generate the following data:

[
    {
        stringItem: "Hello World"
    },
    {
        stringItem: "Hello World"
        booleanItem: true        
    },
    {
        stringItem: "Hello World"
        booleanItem: false        
    }
]

If an example or a default is not provided, fake data will be generated.

Exporting an example

Use the export getExample to retrieve an example piece of data.

permutator.getExample(schema);

Simplifying schemas

Use the export simplifySchemas to show all schema permutations. This can be useful for extrapolating out all possible schema combinations.

permutator.simplifySchemas(schema, references);

Finding properties

Use the export getDeepPropLocations to find properties within the schema.

permutator.getDeepPropLocations(schema, propertyName);

Resolve references

Use the export resolveReferences to resolve the references of a schema by consolidating them with their referenced schema.

permutator.resolveReferences(schema, references);

Resolving properties

Use the export resolveSchemaProps to resolve the given props for a schema.

permutator.resolveSchemaProps(schema, ['$ref', 'allOf']);

Developing

Contribute to the ES6 source files in the lib folder.

Testing

Run npm run test to test the exposed utilities and schemas

Building

Run npm run build to build before npm publish to convert files to ES5 from ES6.

Special properties

  • whitelisted ignores a property
  • example is a piece of supplied example data