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

@pwabuilder/manifest-validation

v0.0.9

Published

Manifest validation library by PWABuilder criteria

Downloads

15

Readme

@pwabuilder/manifest-validation

This package runs our validation tests against a Web Manifest. It can be used in both Node.js and the browser.

Getting Started

  • Get a standard web manifest object as JSON. This can be done in any way you need and is a seperate concern from this package.
  • Start by calling one of the methods below and passing in the manifest JSON from step two. Note that you will first need to import that method first
    • import { validateRequired } from 'manifest-validation';

Methods

  • validateRequiredFields

    • This method will validate the manifest against the required fields.
    • Parameters:
      • manifest: The manifest to validate as a standard JSON object
    • Returns: An array of Validation that contains each field that failed validation
    • Usage Example:
    const result = validateRequiredFields(manifest);
  • reportMissing

    • This method will find all of fields that are missing in the passed manifest
    • Parameters:
      • manifest: The manifest to validate as a standard JSON object
    • Returns: An array of string that contains each field that could not be found in the manifest
    • Usage Example: Same as the above method
  • validateManifest

    • This method will validate the manifest against all fields and all issues
    • Parameters:
      • manifest: The manifest to validate as a standard JSON object
    • Returns: An array of Validation that contains each field that failed validation
    • Usage: Same as the above method
  • validateSingleField

    • This method will validate the value in the web manifest agains the given field + value
      • field: TA member of your Web Manifest that you would like to validate, such as theme_color
      • value: The current value of the field passed in above
    • Returns: a Validation if it failed, true if passed and undefined if the field is not in the manifest
    • Usage:
      const result = validateSingleField("theme_color", "#ffffff");

Types

The following types are exported and can be used in your code by importing the desired type from the package.

// Represents the result of a validation test
interface Validation {
    infoString?: string;
    category: string;
    member: string;
    defaultValue?: string | any[];
    docsLink?: string;
    errorString?: string;
    quickFix: boolean;
    test?: Function;
    testName?: string;
}

// Represents a Web Manifest and includes all
// potential members
interface Manifest {
    ...
}